# paths./1/kmeet/rooms.post.description
This endpoint allows you to plan a conference with predefined settings. It will add an event on your Infomaniak Calendar with the meeting url.
 If you just want to create a room you don't need any API calls, you can build a conference URL by adding an unique identifier to your kMeet instance url (eg: kmeet.infomaniak.com/${MY_VERY_SECRET_CONFERENCE_ID})

# paths./1/kmeet/rooms.post.x-codeSamples[].source
curl -X POST
-H Authorization: Bearer YOUR-TOKEN-HERE
-H "Content-Type: application/json"
-d '{
    "calendar_id": 12,
    "starting_at": "2021-06-01 16:00:00",
    "ending_at": "2021-06-01 20:00:00",
    "timezone": "Europe/Zurich",
    "hostname": "kmeet.infomaniak.com",
    "title": "My event",
    "description": "Describe what we will do during the event.",
    "attendees": [
        {
            "address": "myemail@ik.me",
            "organizer": true,
            "name": "John Doe",
            "state": "ACCEPTED"
        }
    ],
    "options": {
      "subject": "My event",
      "start_audio_muted": false,
      "enable_recording": false,
      "enable_moderator_video": false,
      "start_audio_only": false,
      "lobby_enabled": false,
      "password_enabled": false,
      "e2ee_enabled": false
    }
}'
https://api.infomaniak.com/1/kmeet/rooms

# paths./1/kmeet/rooms/{room_id}/settings.get.description
This endpoint allows you to fetch room settings.

# paths./api/v4/teams/{team_id}/top/reactions.get.summary
Get a list of the top reactions for a team.

# paths./api/v4/teams/{team_id}/top/reactions.get.description
Get a list of the top reactions across all public and private channels (the user is a member of) for a given team.
##### Permissions
Must have `view_team` permission for the team.

# paths./api/v4/teams/{team_id}/top/reactions.get.parameters[].description
Time range can be "today", "7_day", or "28_day".
- `today`: reactions posted on the current day.
- `7_day`: reactions posted in the last 7 days.
- `28_day`: reactions posted in the last 28 days.

# paths./api/v4/teams/{team_id}/top/reactions.get.parameters[].description
The number of items per page, up to a maximum of 200.

# paths./api/v4/users/me/top/reactions.get.summary
Get a list of the top reactions for a user.

# paths./api/v4/users/me/top/reactions.get.description
Get a list of the top reactions across all public and private channels (the user is a member of) for a given user.
If no `team_id` is provided, this will also include reactions posted by the given user in direct and group messages.
##### Permissions
Must be logged in as the user.

# paths./api/v4/users/me/top/reactions.get.parameters[].description
Time range can be "today", "7_day", or "28_day".
- `today`: reactions posted on the current day.
- `7_day`: reactions posted in the last 7 days.
- `28_day`: reactions posted in the last 28 days.

# paths./api/v4/users/me/top/reactions.get.parameters[].description
The number of items per page, up to a maximum of 200.

# paths./api/v4/users/me/top/reactions.get.parameters[].description
Team ID will scope the response to a given team and exclude direct and group messages.
##### Permissions
Must have `view_team` permission for the team.

# paths./api/v4/teams/{team_id}/top/channels.get.summary
Get a list of the top channels for a team.

# paths./api/v4/teams/{team_id}/top/channels.get.description
Get a list of the top public and private channels (the user is a member of) for a given team.
##### Permissions
Must have `view_team` permission for the team.

# paths./api/v4/teams/{team_id}/top/channels.get.parameters[].description
Time range can be "today", "7_day", or "28_day".
- `today`: channels with posts on the current day.
- `7_day`: channels with posts in the last 7 days.
- `28_day`: channels with posts in the last 28 days.

# paths./api/v4/teams/{team_id}/top/channels.get.parameters[].description
The number of items per page, up to a maximum of 200.

# paths./api/v4/users/me/top/channels.get.summary
Get a list of the top channels for a user.

# paths./api/v4/users/me/top/channels.get.description
Get a list of the top public and private channels (the user is a member of) for a given user.
##### Permissions
Must be logged in as the user.

# paths./api/v4/users/me/top/channels.get.parameters[].description
Time range can be "today", "7_day", or "28_day".
- `today`: channels with posts on the current day.
- `7_day`: channels with posts in the last 7 days.
- `28_day`: channels with posts in the last 28 days.

# paths./api/v4/users/me/top/channels.get.parameters[].description
The number of items per page, up to a maximum of 200.

# paths./api/v4/users/me/top/channels.get.parameters[].description
Team ID will scope the response to a given team.
##### Permissions
Must have `view_team` permission for the team.

# paths./api/v4/teams/{team_id}/top/team_members.get.description
Get a list of all of the new team members that have joined the given team during the given time period.
##### Permissions
Must have `view_team` permission for the team.

# paths./api/v4/teams/{team_id}/top/team_members.get.parameters[].description
Time range can be "today", "7_day", or "28_day".
- `today`: team members who joined during the current day.
- `7_day`: team members who joined in the last 7 days.
- `28_day`: team members who joined in the last 28 days.

# paths./api/v4/teams/{team_id}/top/team_members.get.responses.200.description
New team members retrieved successfully.

# paths./api/v4/teams/{team_id}/top/threads.get.summary
Get a list of the top threads for a team.

# paths./api/v4/teams/{team_id}/top/threads.get.description
Get a list of the top threads from public and private channels (the user is a member of) for a given team.
##### Permissions
Must have `view_team` permission for the team.

# paths./api/v4/teams/{team_id}/top/threads.get.parameters[].description
Time range can be "today", "7_day", or "28_day".
- `today`: threads with activity on the current day.
- `7_day`: threads with activity in the last 7 days.
- `28_day`: threads with activity in the last 28 days.

# paths./api/v4/teams/{team_id}/top/threads.get.parameters[].description
The number of items per page, up to a maximum of 200.

# paths./api/v4/users/me/top/threads.get.summary
Get a list of the top threads for a user.

# paths./api/v4/users/me/top/threads.get.description
Get a list of the top threads from public and private channels (the user is a member of and participating in the thread) for a given user.
##### Permissions
Must be logged in as the user.

# paths./api/v4/users/me/top/threads.get.parameters[].description
Time range can be "today", "7_day", or "28_day".
- `today`: threads with activity on the current day.
- `7_day`: threads with activity in the last 7 days.
- `28_day`: threads with activity in the last 28 days.

# paths./api/v4/users/me/top/threads.get.parameters[].description
The number of items per page, up to a maximum of 200.

# paths./api/v4/users/me/top/threads.get.parameters[].description
Team ID will scope the response to a given team.
##### Permissions
Must have `view_team` permission for the team.

# paths./api/v4/users/me/top/dms.get.description
Get a list of the top dms for a given user.
##### Permissions
Must be logged in as the user.

# paths./api/v4/users/me/top/dms.get.parameters[].description
Time range can be "today", "7_day", or "28_day".
- `today`: threads with activity on the current day.
- `7_day`: threads with activity in the last 7 days.
- `28_day`: threads with activity in the last 28 days.

# paths./api/v4/users/me/top/dms.get.parameters[].description
The number of items per page, up to a maximum of 200.

# paths./api/v4/users.get.description
Get a page of a list of users. Based on query string parameters, select users from a team, channel, or select users not in a specific channel.

Some basic sorting is available using the `sort` query parameter. Sorting is currently only supported when selecting users on a team.
##### Permissions
Requires an active session and (if specified) membership to the channel or team being selected from.

# paths./api/v4/users.get.parameters[].description
The number of users per page. There is a maximum limit of 200 users per page.

# paths./api/v4/users.get.parameters[].description
The ID of the team to exclude users for. Must not be used with "in_team" query parameter.

# paths./api/v4/users.get.parameters[].description
The ID of the channel to exclude users for. Must be used with "in_channel" query parameter.

# paths./api/v4/users.get.parameters[].description
The ID of the group to get users for. Must have `manage_system` permission.

# paths./api/v4/users.get.parameters[].description
When used with `not_in_channel` or `not_in_team`, returns only the users that are allowed to join the channel or team based on its group constrains.

# paths./api/v4/users.get.parameters[].description
Whether or not to list users that are not on any team. This option takes precendence over `in_team`, `in_channel`, and `not_in_channel`.

# paths./api/v4/users.get.parameters[].description
Whether or not to list only users that are active. This option cannot be used along with the `inactive` option.

# paths./api/v4/users.get.parameters[].description
Whether or not to list only users that are deactivated. This option cannot be used along with the `active` option.

# paths./api/v4/users.get.parameters[].description
Sort is only available in conjunction with certain options below. The paging parameter is also always available.

##### `in_team`
Can be "", "last_activity_at" or "create_at".
When left blank, sorting is done by username.
##### `in_channel`
Can be "", "status".
When left blank, sorting is done by username. `status` will sort by User's current status (Online, Away, DND, Offline), then by Username.

# paths./api/v4/users.get.parameters[].description
Comma separated string used to filter users based on any of the specified system roles

Example: `?roles=system_admin,system_user` will return users that are either system admins or system users

# paths./api/v4/users.get.parameters[].description
Comma separated string used to filter users based on any of the specified channel roles, can only be used in conjunction with `in_channel`

Example: `?in_channel=4eb6axxw7fg3je5iyasnfudc5y&channel_roles=channel_user` will return users that are only channel users and not admins or guests

# paths./api/v4/users.get.parameters[].description
Comma separated string used to filter users based on any of the specified team roles, can only be used in conjunction with `in_team`

Example: `?in_team=4eb6axxw7fg3je5iyasnfudc5y&team_roles=team_user` will return users that are only team users and not admins or guests

# paths./api/v4/users/ids.post.description
Get a list of users based on a provided list of user ids.
##### Permissions
Requires an active session but no other permissions.

# paths./api/v4/users/ids.post.parameters[].description
Only return users that have been modified since the given Unix timestamp (in milliseconds).

# paths./api/v4/users/group_channels.post.description
Get an object containing a key per group channel id in the
query and its value as a list of users members of that group
channel.

The user must be a member of the group ids in the query, or
they will be omitted from the response.
##### Permissions
Requires an active session but no other permissions.

# paths./api/v4/users/usernames.post.description
Get a list of users based on a provided list of usernames.
##### Permissions
Requires an active session but no other permissions.

# paths./api/v4/users/search.post.description
Get a list of users based on search criteria provided in the request body. Searches are typically done against username, full name, nickname and email unless otherwise configured by the server.
##### Permissions
Requires an active session and `read_channel` and/or `view_team` permissions for any channels or teams specified in the request body.

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.term.description
The term to match against username, full name, nickname and email

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.team_id.description
If provided, only search users on this team

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.not_in_team_id.description
If provided, only search users not on this team

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.in_channel_id.description
If provided, only search users in this channel

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.not_in_channel_id.description
If provided, only search users not in this channel. Must specifiy `team_id` when using this option

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.in_group_id.description
If provided, only search users in this group. Must have `manage_system` permission.

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.group_constrained.description
When used with `not_in_channel_id` or `not_in_team_id`, returns only the users that are allowed to join the channel or team based on its group constrains.

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.allow_inactive.description
When `true`, include deactivated users in the results

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.without_team.description
Set this to `true` if you would like to search for users that are not on a team. This option takes precendence over `team_id`, `in_channel_id`, and `not_in_channel_id`.

# paths./api/v4/users/search.post.requestBody.content.application/json.schema.properties.limit.description
The maximum number of users to return in the results

__Defaults to `100` if not provided.__

# paths./api/v4/users/autocomplete.get.description
Get a list of users for the purpose of autocompleting based on the provided search term. Specify a combination of `team_id` and `channel_id` to filter results further.
##### Permissions
Requires an active session and `view_team` and `read_channel` on any teams or channels used to filter the results further.

# paths./api/v4/users/autocomplete.get.parameters[].description
Username, nickname first name or last name

# paths./api/v4/users/autocomplete.get.parameters[].description
The maximum number of users to return in each subresult

__Defaults to `100` if not provided.__

# paths./api/v4/users/{user_id}.get.description
Get a user a object. Sensitive information will be sanitized out.
##### Permissions
Requires an active session but no other permissions.

# paths./api/v4/users/{user_id}.get.parameters[].description
User GUID. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/patch.put.description
Partially update a user by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.
##### Permissions
Must be logged in as the user being updated or have the `edit_other_users` permission.

# paths./api/v4/users/{user_id}/roles.put.description
Update a user's system-level roles. Valid user roles are "system_user", "system_admin" or both of them. Overwrites any previously assigned system-level roles.
##### Permissions
Must have the `manage_roles` permission.

# paths./api/v4/users/{user_id}/roles.put.requestBody.description
Space-delimited system roles to assign to the user

# paths./api/v4/users/{user_id}/image.get.description
Get a user's profile image based on user_id string parameter.
##### Permissions
Must be logged in.

# paths./api/v4/users/{user_id}/image.get.parameters[].description
Not used by the server. Clients can pass in the last picture update time of the user to potentially take advantage of caching

# paths./api/v4/users/{user_id}/image/default.get.summary
Return user's default (generated) profile image

# paths./api/v4/users/{user_id}/image/default.get.description
Returns the default (generated) user profile image based on user_id string parameter.
##### Permissions
Must be logged in.

# paths./api/v4/users/username/{username}.get.description
Get a user object by providing a username. Sensitive information will be sanitized out.
##### Permissions
Requires an active session but no other permissions.

# paths./api/v4/users/email/{email}.get.description
Get a user object by providing a user email. Sensitive information will be sanitized out.
##### Permissions
Requires an active session and for the current session to be able to view another user's email based on the server's privacy settings.

# paths./api/v4/users/{user_id}/typing.post.description
Notify users in the given channel via websocket that the given user is typing.
##### Permissions
Must have `manage_system` permission to publish for any user other than oneself.

# paths./api/v4/users/{user_id}/typing.post.requestBody.content.application/json.schema.properties.channel_id.description
The id of the channel to which to direct the typing event.

# paths./api/v4/users/{user_id}/typing.post.requestBody.content.application/json.schema.properties.parent_id.description
The optional id of the root post of the thread to which the user is replying. If unset, the typing event is directed at the entire channel.

# paths./api/v4/users/{user_id}/typing.post.responses.200.description
User typing websocket event accepted for publishing.

# paths./api/v4/users/{user_id}/channel_members.get.description
Get all channel members for a user.

##### Permissions
Logged in as the user, or have `edit_other_users` permission.

# paths./api/v4/users/{user_id}/channel_members.get.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/channel_members.get.parameters[].description
Page specifies which part of the results to return, by PageSize.

# paths./api/v4/users/{user_id}/channel_members.get.parameters[].description
PageSize specifies the size of the returned chunk of results.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.description
Get all threads that user is following


##### Permissions
Must be logged in as the user or have `edit_other_users` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
The ID of the team in which the thread is.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
Since filters the threads based on their LastUpdateAt timestamp.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
Deleted will specify that even deleted threads should be returned (For mobile sync).

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
Extended will enrich the response with participant details.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
Page specifies which part of the results to return, by PageSize.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
PageSize specifies the size of the returned chunk of results.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
Setting this to true will only return the total counts.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads.get.parameters[].description
Setting this to true will only return threads.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/read.put.summary
Mark all threads that user is following as read

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/read.put.description
Mark all threads that user is following as read


##### Permissions
Must be logged in as the user or have `edit_other_users` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/read.put.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/read.put.parameters[].description
The ID of the team in which the thread is.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/read.put.summary
Mark a thread that user is following read state to the timestamp

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/read.put.description
Mark a thread that user is following as read


##### Permissions
Must be logged in as the user or have `edit_other_users` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/read.put.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/read.put.parameters[].description
The ID of the team in which the thread is.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/read.put.parameters[].description
The timestamp to which the thread's "last read" state will be reset.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/set_.put.summary
Mark a thread that user is following as unread based on a post id

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/set_.put.description
Mark a thread that user is following as unread

##### Permissions
Must have `read_channel` permission for the channel the thread is in or if the channel is public, have the `read_public_channels` permission for the team.

Must have `edit_other_users` permission if the user is not the one marking the thread for himself.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/set_.put.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/set_.put.parameters[].description
The ID of the team in which the thread is.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/set_.put.parameters[].description
The ID of a post belonging to the thread to mark as unread.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/foll.put.description
Start following a thread


##### Permissions
Must be logged in as the user or have `edit_other_users` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/foll.put.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/foll.put.parameters[].description
The ID of the team in which the thread is.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/foll.delete.description
Stop following a thread


##### Permissions
Must be logged in as the user or have `edit_other_users` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/foll.delete.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}/foll.delete.parameters[].description
The ID of the team in which the thread is.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}.get.description
Get a thread


##### Permissions
Must be logged in as the user or have `edit_other_users` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}.get.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/teams/{team_id}/threads/{thread_id}.get.parameters[].description
The ID of the team in which the thread is.

# paths./api/v4/users/{user_id}/status.get.description
Get user status by id from the server.
##### Permissions
Must be authenticated.

# paths./api/v4/users/{user_id}/status.put.description
Manually set a user's status. When setting a user's status, the status will remain that value until set "online" again, which will return the status to being automatically updated based on user activity.
##### Permissions
Must have `edit_other_users` permission for the team.

# paths./api/v4/users/{user_id}/status.put.requestBody.content.application/json.schema.properties.status.description
User status, can be `online`, `away`, `offline` and `dnd`

# paths./api/v4/users/{user_id}/status.put.requestBody.content.application/json.schema.properties.dnd_end_time.description
Time in epoch seconds at which a dnd status would be unset.

# paths./api/v4/users/status/ids.post.description
Get a list of user statuses by id from the server.
##### Permissions
Must be authenticated.

# paths./api/v4/users/{user_id}/status/custom.put.description
Updates a user's custom status by setting the value in the user's props and updates the user. Also save the given custom status to the recent custom statuses in the user's props
##### Permissions
Must be logged in as the user whose custom status is being updated.

# paths./api/v4/users/{user_id}/status/custom.put.requestBody.content.application/json.schema.properties.duration.description
Duration of custom status, can be `thirty_minutes`, `one_hour`, `four_hours`, `today`, `this_week` or `date_and_time`

# paths./api/v4/users/{user_id}/status/custom.put.requestBody.content.application/json.schema.properties.expires_at.description
The time at which custom status should be expired. It should be in ISO format.

# paths./api/v4/users/{user_id}/status/custom.put.requestBody.description
Custom status object that is to be updated

# paths./api/v4/users/{user_id}/status/custom.delete.description
Unsets a user's custom status by updating the user's props and updates the user
##### Permissions
Must be logged in as the user whose custom status is being removed.

# paths./api/v4/users/{user_id}/status/custom/recent/delete.post.description
Deletes a user's recent custom status by removing the specific status from the recentCustomStatuses in the user's props and updates the user.
##### Permissions
Must be logged in as the user whose recent custom status is being deleted.

# paths./api/v4/users/{user_id}/status/custom/recent/delete.post.requestBody.content.application/json.schema.properties.duration.description
Duration of custom status, can be `thirty_minutes`, `one_hour`, `four_hours`, `today`, `this_week` or `date_and_time`

# paths./api/v4/users/{user_id}/status/custom/recent/delete.post.requestBody.content.application/json.schema.properties.expires_at.description
The time at which custom status should be expired. It should be in ISO format.

# paths./api/v4/users/{user_id}/status/custom/recent/delete.post.requestBody.description
Custom Status object that is to be removed from the recent custom statuses.

# paths./api/v4/users/{user_id}/status/custom/recent/delete.post.responses.200.description
User recent custom status delete successful

# paths./api/v4/teams.get.description
For regular users only returns open teams. Users with the "manage_system" permission will return teams regardless of type. The result is based on query string parameters - page and per_page.
##### Permissions
Must be authenticated.

# paths./api/v4/teams.get.parameters[].description
Appends a total count of returned teams inside the response object - ex: `{ "teams": [], "total_count" : 0 }`.      

# paths./api/v4/teams.get.parameters[].description
If set to true, teams which are part of a data retention policy will be excluded. The `sysconsole_read_compliance` permission is required to use this parameter.

# paths./api/v4/teams/{team_id}.get.description
Get a team on the system.
##### Permissions
Must be authenticated and have the `view_team` permission.

# paths./api/v4/teams/name/{name}.get.description
Get a team based on provided name string
##### Permissions
Must be authenticated, team type is open and have the `view_team` permission.

# paths./api/v4/users/{user_id}/teams.get.description
Get a list of teams that a user is on.
##### Permissions
Must be authenticated as the user or have the `manage_system` permission.

# paths./api/v4/teams/{team_id}/members.get.description
Get a page team members list based on query string parameters - team id, page and per page.
##### Permissions
Must be authenticated and have the `view_team` permission.

# paths./api/v4/users/{user_id}/teams/members.get.description
Get a list of team members for a user. Useful for getting the ids of teams the user is on and the roles they have in those teams.
##### Permissions
Must be logged in as the user or have the `edit_other_users` permission.

# paths./api/v4/teams/{team_id}/members/{user_id}.get.description
Get a team member on the system.
##### Permissions
Must be authenticated and have the `view_team` permission.

# paths./api/v4/teams/{team_id}/members/ids.post.description
Get a list of team members based on a provided array of user ids.
##### Permissions
Must have `view_team` permission for the team.

# paths./api/v4/teams/{team_id}/stats.get.description
Get a team stats on the system.
##### Permissions
Must be authenticated and have the `view_team` permission.

# paths./api/v4/teams/{team_id}/members/{user_id}/roles.put.description
Update a team member roles. Valid team roles are "team_user", "team_admin" or both of them. Overwrites any previously assigned team roles.
##### Permissions
Must be authenticated and have the `manage_team_roles` permission.

# paths./api/v4/teams/{team_id}/members/{user_id}/roles.put.requestBody.description
Space-delimited team roles to assign to the user

# paths./api/v4/users/{user_id}/teams/unread.get.description
Get the count for unread messages and mentions in the teams the user is a member of.
##### Permissions
Must be logged in.

# paths./api/v4/users/{user_id}/teams/unread.get.parameters[].description
Optional team id to be excluded from the results

# paths./api/v4/users/{user_id}/teams/unread.get.parameters[].description
Boolean to determine whether the collapsed threads should be included or not

# paths./api/v4/users/{user_id}/teams/{team_id}/unread.get.description
Get the unread mention and message counts for a team for the specified user.
##### Permissions
Must be the user or have `edit_other_users` permission and have `view_team` permission for the team.

# paths./api/v4/teams/{team_id}/invite-guests/email.post.description
Invite guests to existing team channels usign the user's email.

The number of emails that can be sent is rate limited to 20 per hour with a burst of 20 emails. If the rate limit exceeds, the error message contains details on when to retry and when the timer will be reset.

##### Permissions
Must have `invite_guest` permission for the team.

# paths./api/v4/channels.get.parameters[].description
A group id to exclude channels that are associated with that group via GroupChannel records. This can also be left blank with `not_associated_to_group=`.

# paths./api/v4/channels.get.parameters[].description
Whether to exclude default channels (ex Town Square, Off-Topic) from the results.

# paths./api/v4/channels.get.parameters[].description
Include channels that have been archived. This correlates to the `DeleteAt` flag being set in the database.

# paths./api/v4/channels.get.parameters[].description
Appends a total count of returned channels inside the response object - ex: `{ "channels": [], "total_count" : 0 }`.      

# paths./api/v4/channels.get.parameters[].description
If set to true, channels which are part of a data retention policy will be excluded. The `sysconsole_read_compliance` permission is required to use this parameter.

# paths./api/v4/channels.post.description
Create a new channel.
##### Permissions
If creating a public channel, `create_public_channel` permission is required. If creating a private channel, `create_private_channel` permission is required.

# paths./api/v4/channels.post.requestBody.content.application/json.schema.properties.team_id.description
The team ID of the team to create the channel on

# paths./api/v4/channels.post.requestBody.content.application/json.schema.properties.name.description
The unique handle for the channel, will be present in the channel URL

# paths./api/v4/channels.post.requestBody.content.application/json.schema.properties.purpose.description
A short description of the purpose of the channel

# paths./api/v4/channels.post.requestBody.content.application/json.schema.properties.header.description
Markdown-formatted text to display in the header of the channel

# paths./api/v4/channels.post.requestBody.content.application/json.schema.properties.type.description
'O' for a public channel, 'P' for a private channel

# paths./api/v4/channels/direct.post.description
Create a new direct message channel between two users.
##### Permissions
Must be one of the two users and have `create_direct_channel` permission. Having the `manage_system` permission voids the previous requirements.

# paths./api/v4/channels/direct.post.requestBody.description
The two user ids to be in the direct message

# paths./api/v4/channels/group.post.description
Create a new group message channel to group of users. If the logged in user's id is not included in the list, it will be appended to the end.
##### Permissions
Must have `create_group_channel` permission.

# paths./api/v4/channels/group.post.requestBody.description
User ids to be in the group message channel

# paths./api/v4/channels/search.post.summary
Search all private and open type channels

# paths./api/v4/channels/search.post.description
Returns all private and open type channels where 'term' matches on the name, display name, or purpose of
the channel.

Configured 'default' channels (ex Town Square and Off-Topic) can be excluded from the results
with the `exclude_default_channels` boolean parameter.

Channels that are associated (via GroupChannel records) to a given group can be excluded from the results
with the `not_associated_to_group` parameter and a group id string.

# paths./api/v4/channels/search.post.parameters[].description
Is the request from system_console. If this is set to true, it filters channels by the logged in user.

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.term.description
The string to search in the channel name, display name, and purpose.

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.not_associated_to_group.description
A group id to exclude channels that are associated to that group via GroupChannel records.

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.exclude_default_channels.description
Exclude default channels from the results by setting this parameter to true.

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.team_ids.description
Filters results to channels belonging to the given team ids

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.group_constrained.description
Filters results to only return channels constrained to a group

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.exclude_group_constrained.description
Filters results to exclude channels constrained to a group

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.public.description
Filters results to only return Public / Open channels, can be used in conjunction with `private` to return both `public` and `private` channels

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.private.description
Filters results to only return Private channels, can be used in conjunction with `public` to return both `private` and `public` channels

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.deleted.description
Filters results to only return deleted / archived channels

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.page.description
The page number to return, if paginated. If this parameter is not present with the `per_page` parameter then the results will be returned un-paged.

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.per_page.description
The number of entries to return per page, if paginated. If this parameter is not present with the `page` parameter then the results will be returned un-paged.

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.exclude_policy_constrained.description
If set to true, only channels which do not have a granular retention policy assigned to them will be returned. The `sysconsole_read_compliance_data_retention` permission is required to use this parameter.

# paths./api/v4/channels/search.post.requestBody.content.application/json.schema.properties.include_search_by_id.description
If set to true, returns channels where given search 'term' matches channel ID.

# paths./api/v4/channels/search.post.requestBody.description
The search terms and logic to use in the search.

# paths./api/v4/channels/search.post.responses.200.description
Paginated channel response. (Note that the non-paginated response—returned if the request body does not contain both `page` and `per_page` fields—is a simple array of channels.)

# paths./api/v4/channels/search.post.responses.200.content.application/json.schema.properties.total_count.description
The total number of results, regardless of page and per_page requested.

# paths./api/v4/channels/group/search.post.description
Get a list of group channels for a user which members' usernames match the search term.

# paths./api/v4/channels/group/search.post.requestBody.content.application/json.schema.properties.term.description
The search term to match against the members' usernames of the group channels

# paths./api/v4/teams/{team_id}/channels/ids.post.description
Get a list of public channels on a team by id.
##### Permissions
`view_team` for the team the channels are on.

# paths./api/v4/channels/{channel_id}.get.description
Get channel from the provided channel id string.
##### Permissions
`read_channel` permission for the channel.

# paths./api/v4/channels/{channel_id}.put.description
Update a channel. The fields that can be updated are listed as parameters. Omitted fields will be treated as blanks.
##### Permissions
If updating a public channel, `manage_public_channel_members` permission is required. If updating a private channel, `manage_private_channel_members` permission is required.

# paths./api/v4/channels/{channel_id}.put.requestBody.content.application/json.schema.properties.name.description
The unique handle for the channel, will be present in the channel URL

# paths./api/v4/channels/{channel_id}.put.requestBody.content.application/json.schema.properties.purpose.description
A short description of the purpose of the channel

# paths./api/v4/channels/{channel_id}.put.requestBody.content.application/json.schema.properties.header.description
Markdown-formatted text to display in the header of the channel

# paths./api/v4/channels/{channel_id}.delete.description
Archives a channel. This will set the `deleteAt` to the current timestamp in the database. Soft deleted channels may not be accessible in the user interface. They can be viewed and unarchived in the **System Console > User Management > Channels** based on your license. Direct and group message channels cannot be deleted.

##### Permissions
`delete_public_channel` permission if the channel is public,
`delete_private_channel` permission if the channel is private,
or have `manage_system` permission.

# paths./api/v4/channels/{channel_id}/patch.put.description
Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.
##### Permissions
If updating a public channel, `manage_public_channel_members` permission is required. If updating a private channel, `manage_private_channel_members` permission is required.

# paths./api/v4/channels/{channel_id}/patch.put.requestBody.content.application/json.schema.properties.name.description
The unique handle for the channel, will be present in the channel URL

# paths./api/v4/channels/{channel_id}/patch.put.requestBody.content.application/json.schema.properties.purpose.description
A short description of the purpose of the channel

# paths./api/v4/channels/{channel_id}/patch.put.requestBody.content.application/json.schema.properties.header.description
Markdown-formatted text to display in the header of the channel

# paths./api/v4/channels/{channel_id}/privacy.put.description
Updates channel's privacy allowing changing a channel from Public to Private and back.

##### Permissions
`convert_public_channel_to_private` permission for the channel if updating privacy to 'P'. `convert_private_channel_to_public` permission for the channel if updating privacy to 'O'.

# paths./api/v4/channels/{channel_id}/privacy.put.requestBody.content.application/json.schema.properties.privacy.description
Channel privacy setting: 'O' for a public channel, 'P' for a private channel

# paths./api/v4/channels/{channel_id}/restore.post.description
Restore channel from the provided channel id string.

##### Permissions
`manage_team` permission for the team of the channel.

# paths./api/v4/channels/{channel_id}/move.post.description
Move a channel to another team.


##### Permissions

Must have `manage_system` permission.

# paths./api/v4/channels/{channel_id}/move.post.requestBody.content.application/json.schema.properties.force.description
Remove members those are not member of target team before moving the channel.

# paths./api/v4/channels/{channel_id}/stats.get.description
Get statistics for a channel.
##### Permissions
Must have the `read_channel` permission.

# paths./api/v4/teams/{team_id}/channels.get.description
Get a page of public channels on a team based on query string parameters - page and per_page.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/teams/{team_id}/channels/private.get.description
Get a page of private channels on a team based on query string
parameters - team_id, page and per_page.


##### Permissions
Must have `manage_system` permission.

# paths./api/v4/teams/{team_id}/channels/private.get.parameters[].description
The number of private channels per page.

# paths./api/v4/teams/{team_id}/channels/deleted.get.description
Get a page of deleted channels on a team based on query string parameters - team_id, page and per_page.

# paths./api/v4/teams/{team_id}/channels/autocomplete.get.description
Autocomplete public channels on a team based on the search term provided in the request URL.

##### Permissions
Must have the `list_team_channels` permission.

# paths./api/v4/teams/{team_id}/channels/search_autocomplete.get.description
Autocomplete your channels on a team based on the search term provided in the request URL.

##### Permissions
Must have the `list_team_channels` permission.

# paths./api/v4/teams/{team_id}/channels/search.post.description
Search public channels on a team based on the search term provided in the request body.
##### Permissions
Must have the `list_team_channels` permission.

A user without the `list_team_channels` permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.

# paths./api/v4/teams/{team_id}/channels/search.post.requestBody.content.application/json.schema.properties.term.description
The search term to match against the name or display name of channels

# paths./api/v4/teams/{team_id}/channels/search_archived.post.description
Search archived channels on a team based on the search term provided in the request body.

##### Permissions
Must have the `list_team_channels` permission.

A user without the `list_team_channels` permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.

# paths./api/v4/teams/{team_id}/channels/search_archived.post.requestBody.content.application/json.schema.properties.term.description
The search term to match against the name or display name of archived channels

# paths./api/v4/teams/{team_id}/channels/name/{channel_name}.get.description
Gets channel from the provided team id and channel name strings.
##### Permissions
`read_channel` permission for the channel.

# paths./api/v4/teams/{team_id}/channels/name/{channel_name}.get.parameters[].description
Defines if deleted channels should be returned or not

# paths./api/v4/teams/name/{team_name}/channels/name/{channel_name}.get.description
Gets a channel from the provided team name and channel name strings.
##### Permissions
`read_channel` permission for the channel.

# paths./api/v4/teams/name/{team_name}/channels/name/{channel_name}.get.parameters[].description
Defines if deleted channels should be returned or not

# paths./api/v4/channels/{channel_id}/members.get.description
Get a page of members for a channel.
##### Permissions
`read_channel` permission for the channel.

# paths./api/v4/channels/{channel_id}/members.get.parameters[].description
The number of members per page. There is a maximum limit of 200 members.

# paths./api/v4/channels/{channel_id}/members.post.description
Add a user(s) to a channel by creating a channel member object(s).

# paths./api/v4/channels/{channel_id}/members.post.requestBody.content.application/json.schema.properties.user_id.description
The ID of user to add into the channel, for backwards compatibility.

# paths./api/v4/channels/{channel_id}/members.post.requestBody.content.application/json.schema.properties.user_ids.description
The IDs of users to add into the channel, required if 'user_id' doess not exist.

# paths./api/v4/channels/{channel_id}/members.post.requestBody.content.application/json.schema.properties.post_root_id.description
The ID of root post where link to add channel member originates

# paths./api/v4/channels/{channel_id}/members/ids.post.description
Get a list of channel members based on the provided user ids.
##### Permissions
Must have the `read_channel` permission.

# paths./api/v4/channels/{channel_id}/members/ids.post.responses.200.description
Channel member list retrieval successful

# paths./api/v4/channels/{channel_id}/members/{user_id}.get.description
Get a channel member.
##### Permissions
`read_channel` permission for the channel.

# paths./api/v4/channels/{channel_id}/members/{user_id}.delete.description
Delete a channel member, effectively removing them from a channel.

Channel members can only be deleted from public or private channels.
##### Permissions
`manage_public_channel_members` permission if the channel is public.
`manage_private_channel_members` permission if the channel is private.

# paths./api/v4/channels/{channel_id}/members/{user_id}/roles.put.description
Update a user's roles for a channel.
##### Permissions
Must have `manage_channel_roles` permission for the channel.

# paths./api/v4/channels/{channel_id}/members/{user_id}/roles.put.requestBody.description
Space-delimited channel roles to assign to the user

# paths./api/v4/channels/{channel_id}/members/{user_id}/schemeRoles.put.summary
Update the scheme-derived roles of a channel member.

# paths./api/v4/channels/{channel_id}/members/{user_id}/schemeRoles.put.description
Update a channel member's scheme_admin/scheme_user properties. Typically this should either be `scheme_admin=false, scheme_user=true` for ordinary channel member, or `scheme_admin=true, scheme_user=true` for a channel admin.
##### Permissions
Must be authenticated and have the `manage_channel_roles` permission.

# paths./api/v4/channels/{channel_id}/members/{user_id}/schemeRoles.put.responses.200.description
Channel member's scheme-derived roles updated successfully.

# paths./api/v4/channels/{channel_id}/members/{user_id}/notify_props.put.description
Update a user's notification properties for a channel. Only the provided fields are updated.
##### Permissions
Must be logged in as the user or have `edit_other_users` permission.

# paths./api/v4/channels/members/{user_id}/view.post.description
Perform all the actions involved in viewing a channel. This includes marking channels as read, clearing push notifications, and updating the active channel.

# paths./api/v4/channels/members/{user_id}/view.post.requestBody.content.application/json.schema.properties.channel_id.description
The channel ID that is being viewed. Use a blank string to indicate that all channels have lost focus.

# paths./api/v4/channels/members/{user_id}/view.post.requestBody.content.application/json.schema.properties.prev_channel_id.description
The channel ID of the previous channel, used when switching channels. Providing this ID will cause push notifications to clear on the channel being switched to.

# paths./api/v4/channels/members/{user_id}/view.post.requestBody.description
Paremeters affecting how and which channels to view

# paths./api/v4/channels/members/{user_id}/view.post.responses.200.content.application/json.schema.properties.last_viewed_at_times.description
A JSON object mapping channel IDs to the channel view times

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/members.get.summary
Get channel memberships and roles for a user

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/members.get.description
Get all channel memberships and associated membership roles (i.e. `channel_user`, `channel_admin`) for a user on a specific team.
##### Permissions
Logged in as the user and `view_team` permission for the team. Having `manage_system` permission voids the previous requirements.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels.get.description
Get all the channels on a team for a user.
##### Permissions
Logged in as the user, or have `edit_other_users` permission, and `view_team` permission for the team.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels.get.parameters[].description
Defines if deleted channels should be returned or not

# paths./api/v4/users/{user_id}/teams/{team_id}/channels.get.parameters[].description
Filters the deleted channels by this time in epoch format. Does not have any effect if include_deleted is set to false.

# paths./api/v4/users/{user_id}/channels.get.description
Get all channels that a user is a member of.

##### Permissions

Logged in as the user, or have `edit_other_users` permission.

# paths./api/v4/users/{user_id}/channels.get.parameters[].description
The ID of the user. This can also be "me" which will point to the current user.

# paths./api/v4/users/{user_id}/channels.get.parameters[].description
Filters the deleted channels by this time in epoch format. Does not have any effect if include_deleted is set to false.

# paths./api/v4/users/{user_id}/channels.get.parameters[].description
Defines if deleted channels should be returned or not

# paths./api/v4/users/{user_id}/channels/{channel_id}/unread.get.description
Get the total unread messages and mentions for a channel for a user.
##### Permissions
Must be logged in as user and have the `read_channel` permission, or have `edit_other_usrs` permission.

# paths./api/v4/channels/{channel_id}/scheme.put.description
Set a channel's scheme, more specifically sets the scheme_id value of a channel record.

##### Permissions
Must have `manage_system` permission.

# paths./api/v4/channels/{channel_id}/moderations.get.summary
Get information about channel's moderation.

# paths./api/v4/channels/{channel_id}/moderations.get.description
##### Permissions
Must have `manage_system` permission.

# paths./api/v4/channels/{channel_id}/moderations/patch.put.description
##### Permissions
Must have `manage_system` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/categories.get.description
Get a list of sidebar categories that will appear in the user's sidebar on the given team, including a list of channel IDs in each category.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/categories.post.description
Create a custom sidebar category for the user on the given team.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/categories.put.description
Update any number of sidebar categories for the user on the given team. This can be used to reorder the channels in these categories.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/categories/orde.get.description
Returns the order of the sidebar categories for a user on the given team as an array of IDs.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/categories/orde.put.description
Updates the order of the sidebar categories for a user on the given team. The provided array must include the IDs of all categories on the team.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/categories/{cat.get.description
Returns a single sidebar category for the user on the given team.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/categories/{cat.put.description
Updates a single sidebar category for the user on the given team.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/users/{user_id}/teams/{team_id}/channels/categories/{cat.delete.description
Deletes a single sidebar category for the user on the given team. Only custom categories can be deleted.
##### Permissions
Must be authenticated and have the `list_team_channels` permission.

# paths./api/v4/posts.post.description
Create a new post in a channel. To create the post as a comment on another post, provide `root_id`.
##### Permissions
Must have `create_post` permission for the channel the post is being created in.

# paths./api/v4/posts.post.parameters[].description
Whether to set the user status as online or not.

# paths./api/v4/posts.post.requestBody.content.application/json.schema.properties.message.description
The message contents, can be formatted with Markdown

# paths./api/v4/posts.post.requestBody.content.application/json.schema.properties.file_ids.description
A list of file IDs to associate with the post. Note that posts are limited to 5 files maximum. Please use additional posts for more files.

# paths./api/v4/posts.post.requestBody.content.application/json.schema.properties.props.description
A general JSON property bag to attach to the post

# paths./api/v4/posts.post.requestBody.content.application/json.schema.properties.metadata.description
A JSON object to add post metadata, e.g the post's priority

# paths./api/v4/posts.post.requestBody.content.application/json.schema.properties.metadata.properties.priority.description
An object containing the post's priority properties

# paths./api/v4/posts.post.requestBody.content.application/json.schema.properties.metadata.properties.priority.properties.priority.description
The priority label of the post, could empty, important, or urgent

# paths./api/v4/posts.post.requestBody.content.application/json.schema.properties.metadata.properties.priority.properties.requested_ack.description
Set to true to request for acknowledgements

# paths./api/v4/posts/ephemeral.post.description
Create a new ephemeral post in a channel.
##### Permissions
Must have `create_post_ephemeral` permission (currently only given to system admin)

# paths./api/v4/posts/ephemeral.post.requestBody.content.application/json.schema.properties.user_id.description
The target user id for the ephemeral post

# paths./api/v4/posts/ephemeral.post.requestBody.content.application/json.schema.properties.post.properties.message.description
The message contents, can be formatted with Markdown

# paths./api/v4/posts/{post_id}.get.description
Get a single post.
##### Permissions
Must have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.

# paths./api/v4/posts/{post_id}.get.parameters[].description
Defines if result should include deleted posts, must have 'manage_system' (admin) permission.

# paths./api/v4/posts/{post_id}.get.responses.200.headers.Has-Inaccessible-Posts.description
This header is included with the value "true" if the post is past the cloud's plan limit.

# paths./api/v4/posts/{post_id}.delete.description
Soft deletes a post, by marking the post as deleted in the database. Soft deleted posts will not be returned in post queries.
##### Permissions
Must be logged in as the user or have `delete_others_posts` permission.

# paths./api/v4/users/{user_id}/posts/{post_id}/set_unread.post.description
Mark a channel as being unread from a given post.
##### Permissions
Must have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.
Must have `edit_other_users` permission if the user is not the one marking the post for himself.

# paths./api/v4/posts/{post_id}/patch.put.description
Partially update a post by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.
##### Permissions
Must have the `edit_post` permission.

# paths./api/v4/posts/{post_id}/patch.put.requestBody.content.application/json.schema.properties.is_pinned.description
Set to `true` to pin the post to the channel it is in

# paths./api/v4/posts/{post_id}/thread.get.description
Get a post and the rest of the posts in the same thread.
##### Permissions
Must have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.

# paths./api/v4/posts/{post_id}/thread.get.parameters[].description
The post_id to return the next page of posts from

# paths./api/v4/posts/{post_id}/thread.get.parameters[].description
The create_at timestamp to return the next page of posts from

# paths./api/v4/posts/{post_id}/thread.get.parameters[].description
The direction to return the posts. Either up or down.

# paths./api/v4/posts/{post_id}/thread.get.parameters[].description
Whether to return the associated users as part of the response or not

# paths./api/v4/users/{user_id}/posts/flagged.get.description
Get a page of flagged posts of a user provided user id string. Selects from a channel, team, or all flagged posts by a user. Will only return posts from channels in which the user is member.
##### Permissions
Must be user or have `manage_system` permission.

# paths./api/v4/posts/{post_id}/files/info.get.description
Gets a list of file information objects for the files attached to a post.
##### Permissions
Must have `read_channel` permission for the channel the post is in.

# paths./api/v4/posts/{post_id}/files/info.get.parameters[].description
Defines if result should include deleted posts, must have 'manage_system' (admin) permission.

# paths./api/v4/channels/{channel_id}/posts.get.description
Get a page of posts in a channel. Use the query parameters to modify the behaviour of this endpoint. The parameter `since` must not be used with any of `before`, `after`, `page`, and `per_page` parameters.
If `since` is used, it will always return all posts modified since that time, ordered by their create time limited till 1000. A caveat with this parameter is that there is no guarantee that the returned posts will be consecutive. It is left to the clients to maintain state and fill any missing holes in the post order.
##### Permissions
Must have `read_channel` permission for the channel.

# paths./api/v4/channels/{channel_id}/posts.get.parameters[].description
Provide a non-zero value in Unix time milliseconds to select posts modified after that time

# paths./api/v4/channels/{channel_id}/posts.get.parameters[].description
A post id to select the posts that came before this one

# paths./api/v4/channels/{channel_id}/posts.get.parameters[].description
A post id to select the posts that came after this one

# paths./api/v4/channels/{channel_id}/posts.get.parameters[].description
Whether to include deleted posts or not. Must have system admin permissions.

# paths./api/v4/users/{user_id}/channels/{channel_id}/posts/unread.get.description
Get the oldest unread post in the channel for the given user as well as the posts around it. The returned list is sorted in descending order (most recent post first).
##### Permissions
Must be logged in as the user or have `edit_other_users` permission, and must have `read_channel` permission for the channel.

# paths./api/v4/users/{user_id}/channels/{channel_id}/posts/unread.get.parameters[].description
Number of posts before the oldest unread posts. Maximum is 200 posts if limit is set greater than that.

# paths./api/v4/users/{user_id}/channels/{channel_id}/posts/unread.get.parameters[].description
Number of posts after and including the oldest unread post. Maximum is 200 posts if limit is set greater than that.

# paths./api/v4/users/{user_id}/channels/{channel_id}/posts/unread.get.parameters[].description
Whether to return the associated users as part of the response or not

# paths./api/v4/teams/{team_id}/posts/search.post.description
Search posts in the team and from the provided terms string.
##### Permissions
Must be authenticated and have the `view_team` permission.

# paths./api/v4/teams/{team_id}/posts/search.post.requestBody.content.application/json.schema.properties.terms.description
The search terms as inputed by the user. To search for posts from a user include `from:someusername`, using a user's username. To search in a specific channel include `in:somechannel`, using the channel name (not the display name).

# paths./api/v4/teams/{team_id}/posts/search.post.requestBody.content.application/json.schema.properties.is_or_search.description
Set to true if an Or search should be performed vs an And search.

# paths./api/v4/teams/{team_id}/posts/search.post.requestBody.content.application/json.schema.properties.time_zone_offset.description
Offset from UTC of user timezone for date searches.

# paths./api/v4/teams/{team_id}/posts/search.post.requestBody.content.application/json.schema.properties.include_deleted_channels.description
Set to true if deleted channels should be included in the search. (archived channels)

# paths./api/v4/teams/{team_id}/posts/search.post.requestBody.content.application/json.schema.properties.page.description
The page to select. (Only works with Elasticsearch)

# paths./api/v4/teams/{team_id}/posts/search.post.requestBody.content.application/json.schema.properties.per_page.description
The number of posts per page. (Only works with Elasticsearch)

# paths./api/v4/teams/{team_id}/posts/search.post.requestBody.description
The search terms and logic to use in the search.

# paths./api/v4/posts/{post_id}/pin.post.description
Pin a post to a channel it is in based from the provided post id string.
##### Permissions
Must be authenticated and have the `read_channel` permission to the channel the post is in.

# paths./api/v4/posts/{post_id}/unpin.post.description
Unpin a post to a channel it is in based from the provided post id string.
##### Permissions
Must be authenticated and have the `read_channel` permission to the channel the post is in.

# paths./api/v4/posts/{post_id}/actions/{action_id}.post.description
Perform a post action, which allows users to interact with integrations through posts.
##### Permissions
Must be authenticated and have the `read_channel` permission to the channel the post is in.

# paths./api/v4/posts/ids.post.description
Fetch a list of posts based on the provided postIDs
##### Permissions
Must have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.

# paths./api/v4/posts/ids.post.responses.200.headers.Has-Inaccessible-Posts.description
Indicates whether the posts have been truncated as per the cloud's plan limit.

# paths./api/v4/users/{user_id}/posts/{post_id}/reminder.post.description
Set a reminder for the user for the post.
##### Permissions
Must have `read_channel` permission for the channel the post is in.

# paths./api/v4/users/{user_id}/preferences.get.description
Get a list of the user's preferences.
##### Permissions
Must be logged in as the user being updated or have the `edit_other_users` permission.

# paths./api/v4/users/{user_id}/preferences.put.description
Save a list of the user's preferences.
##### Permissions
Must be logged in as the user being updated or have the `edit_other_users` permission.

# paths./api/v4/users/{user_id}/preferences/delete.post.description
Delete a list of the user's preferences.
##### Permissions
Must be logged in as the user being updated or have the `edit_other_users` permission.

# paths./api/v4/users/{user_id}/preferences/{category}.get.description
Lists the current user's stored preferences in the given category.
##### Permissions
Must be logged in as the user being updated or have the `edit_other_users` permission.

# paths./api/v4/users/{user_id}/preferences/{category}.get.responses.200.description
A list of all of the current user's preferences in the given category

# paths./api/v4/users/{user_id}/preferences/{category}/name/{preference_.get.description
Gets a single preference for the current user with the given category and name.
##### Permissions
Must be logged in as the user being updated or have the `edit_other_users` permission.

# paths./api/v4/users/{user_id}/preferences/{category}/name/{preference_.get.responses.200.description
A single preference for the current user in the current categorylist of all of the current user's preferences in the given category.

# paths./api/v4/files.post.description
Uploads a file that can later be attached to a post.

This request can either be a multipart/form-data request with a channel_id, files and optional
client_ids defined in the FormData, or it can be a request with the channel_id and filename
defined as query parameters with the contents of a single file in the body of the request.

# paths./api/v4/files.post.parameters[].description
The ID of the channel that this file will be uploaded to

# paths./api/v4/files.post.responses.201.description
Corresponding lists of the provided client_ids and the metadata that has been stored in the database for each one

# paths./api/v4/files.post.responses.201.content.application/json.schema.properties.file_infos.description
A list of file metadata that has been stored in the database

# paths./api/v4/files.post.responses.201.content.application/json.schema.properties.client_ids.description
A list of the client_ids that were provided in the request

# paths./api/v4/files/{file_id}.get.description
Gets a file that has been uploaded previously.
##### Permissions
Must have `read_channel` permission or be uploader of the file.

# paths./api/v4/files/{file_id}.get.responses.403.headers.First-Inaccessible-File-Time.description
This header is included with the value "1" if the file is past the cloud's plan limit.

# paths./api/v4/files/{file_id}/thumbnail.get.description
Gets a file's thumbnail.
##### Permissions
Must have `read_channel` permission or be uploader of the file.

# paths./api/v4/files/{file_id}/thumbnail.get.responses.403.headers.First-Inaccessible-File-Time.description
This header is included with the value "1" if the file is past the cloud's plan limit.

# paths./api/v4/files/{file_id}/preview.get.description
Gets a file's preview.
##### Permissions
Must have `read_channel` permission or be uploader of the file.

# paths./api/v4/files/{file_id}/preview.get.responses.403.headers.First-Inaccessible-File-Time.description
This header is included with the value "1" if the file is past the cloud's plan limit.

# paths./api/v4/files/{file_id}/info.get.description
Gets a file's info.
##### Permissions
Must have `read_channel` permission or be uploader of the file.

# paths./api/v4/files/{file_id}/info.get.responses.403.headers.First-Inaccessible-File-Time.description
This header is included with the value "1" if the file is past the cloud's plan limit.

# paths./api/v4/teams/{team_id}/files/search.post.description
Search for files in a team based on file name, extention and file content (if file content extraction is enabled and supported for the files).
##### Permissions
Must be authenticated and have the `view_team` permission.

# paths./api/v4/teams/{team_id}/files/search.post.requestBody.content.application/json.schema.properties.terms.description
The search terms as inputed by the user. To search for files from a user include `from:someusername`, using a user's username. To search in a specific channel include `in:somechannel`, using the channel name (not the display name). To search for specific extensions included `ext:extension`.

# paths./api/v4/teams/{team_id}/files/search.post.requestBody.content.application/json.schema.properties.is_or_search.description
Set to true if an Or search should be performed vs an And search.

# paths./api/v4/teams/{team_id}/files/search.post.requestBody.content.application/json.schema.properties.time_zone_offset.description
Offset from UTC of user timezone for date searches.

# paths./api/v4/teams/{team_id}/files/search.post.requestBody.content.application/json.schema.properties.include_deleted_channels.description
Set to true if deleted channels should be included in the search. (archived channels)

# paths./api/v4/teams/{team_id}/files/search.post.requestBody.content.application/json.schema.properties.page.description
The page to select. (Only works with Elasticsearch)

# paths./api/v4/teams/{team_id}/files/search.post.requestBody.content.application/json.schema.properties.per_page.description
The number of posts per page. (Only works with Elasticsearch)

# paths./api/v4/teams/{team_id}/files/search.post.requestBody.description
The search terms and logic to use in the search.

# paths./api/v4/config/client.get.description
Get a subset of the server configuration needed by the client.
##### Permissions
No permission required.

# paths./api/v4/config/client.get.parameters[].description
Must be `old`, other formats not implemented yet

# paths./api/v4/emoji.post.description
Create a custom emoji for the team.
##### Permissions
Must be authenticated.

# paths./api/v4/emoji.post.requestBody.content.application/json.schema.properties.emoji.description
A JSON object containing a `name` field with the name of the emoji and a `creator_id` field with the id of the authenticated user.

# paths./api/v4/emoji.get.description
Get a page of metadata for custom emoji on the system.##### Permissions
Must be authenticated.

# paths./api/v4/emoji.get.parameters[].description
Either blank for no sorting or "name" to sort by emoji names.

# paths./api/v4/emoji/{emoji_id}.get.description
Get some metadata for a custom emoji.
##### Permissions
Must be authenticated.

# paths./api/v4/emoji/{emoji_id}.delete.description
Delete a custom emoji.
##### Permissions
Must have the `manage_team` or `manage_system` permissions or be the user who created the emoji.

# paths./api/v4/emoji/name/{emoji_name}.get.description
Get some metadata for a custom emoji using its name.
##### Permissions
Must be authenticated.

# paths./api/v4/emoji/{emoji_id}/image.get.description
Get the image for a custom emoji.
##### Permissions
Must be authenticated.

# paths./api/v4/emoji/search.post.description
Search for custom emoji by name based on search criteria provided in the request body. A maximum of 200 results are returned.
##### Permissions
Must be authenticated.

# paths./api/v4/emoji/search.post.requestBody.content.application/json.schema.properties.term.description
The term to match against the emoji name.

# paths./api/v4/emoji/search.post.requestBody.content.application/json.schema.properties.prefix_only.description
Set to only search for names starting with the search term.

# paths./api/v4/emoji/autocomplete.get.description
Get a list of custom emoji with names starting with or matching the provided name. Returns a maximum of 100 results.
##### Permissions
Must be authenticated.

# paths./api/v4/hooks/incoming.post.description
Create an incoming webhook for a channel.
##### Permissions
`manage_webhooks` for the team the webhook is in.

`manage_others_incoming_webhooks` for the team the webhook is in if the user is different than the requester.

# paths./api/v4/hooks/incoming.post.requestBody.content.application/json.schema.properties.channel_id.description
The ID of a public channel or private group that receives the webhook payloads.

# paths./api/v4/hooks/incoming.post.requestBody.content.application/json.schema.properties.user_id.description
The ID of the owner of the webhook if different than the requester.

# paths./api/v4/hooks/incoming.post.requestBody.content.application/json.schema.properties.display_name.description
The display name for this incoming webhook

# paths./api/v4/hooks/incoming.post.requestBody.content.application/json.schema.properties.description.description
The description for this incoming webhook

# paths./api/v4/hooks/incoming.post.requestBody.content.application/json.schema.properties.username.description
The username this incoming webhook will post as.

# paths./api/v4/hooks/incoming.post.requestBody.content.application/json.schema.properties.icon_url.description
The profile picture this incoming webhook will use when posting.

# paths./api/v4/hooks/incoming.get.description
Get a page of a list of incoming webhooks. Optionally filter for a specific team using query parameters.
##### Permissions
`manage_webhooks` for the system or `manage_webhooks` for the specific team.

# paths./api/v4/hooks/incoming/{hook_id}.get.description
Get an incoming webhook given the hook id.
##### Permissions
`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.

# paths./api/v4/hooks/incoming/{hook_id}.delete.description
Delete an incoming webhook given the hook id.
##### Permissions
`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.

# paths./api/v4/hooks/incoming/{hook_id}.put.description
Update an incoming webhook given the hook id.
##### Permissions
`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.

# paths./api/v4/hooks/incoming/{hook_id}.put.requestBody.content.application/json.schema.properties.channel_id.description
The ID of a public channel or private group that receives the webhook payloads.

# paths./api/v4/hooks/incoming/{hook_id}.put.requestBody.content.application/json.schema.properties.display_name.description
The display name for this incoming webhook

# paths./api/v4/hooks/incoming/{hook_id}.put.requestBody.content.application/json.schema.properties.description.description
The description for this incoming webhook

# paths./api/v4/hooks/incoming/{hook_id}.put.requestBody.content.application/json.schema.properties.username.description
The username this incoming webhook will post as.

# paths./api/v4/hooks/incoming/{hook_id}.put.requestBody.content.application/json.schema.properties.icon_url.description
The profile picture this incoming webhook will use when posting.

# paths./api/v4/hooks/outgoing.post.description
Create an outgoing webhook for a team.
##### Permissions
`manage_webhooks` for the team the webhook is in.

`manage_others_outgoing_webhooks` for the team the webhook is in if the user is different than the requester.

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.team_id.description
The ID of the team that the webhook watchs

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.channel_id.description
The ID of a public channel that the webhook watchs

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.creator_id.description
The ID of the owner of the webhook if different than the requester.

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.description.description
The description for this outgoing webhook

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.display_name.description
The display name for this outgoing webhook

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.trigger_words.description
List of words for the webhook to trigger on

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.trigger_when.description
When to trigger the webhook, `0` when a trigger word is present at all and `1` if the message starts with a trigger word

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.callback_urls.description
The URLs to POST the payloads to when the webhook is triggered

# paths./api/v4/hooks/outgoing.post.requestBody.content.application/json.schema.properties.content_type.description
The format to POST the data in, either `application/json` or `application/x-www-form-urlencoded`

# paths./api/v4/hooks/outgoing.get.description
Get a page of a list of outgoing webhooks. Optionally filter for a specific team or channel using query parameters.
##### Permissions
`manage_webhooks` for the system or `manage_webhooks` for the specific team/channel.

# paths./api/v4/hooks/outgoing/{hook_id}.get.description
Get an outgoing webhook given the hook id.
##### Permissions
`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.

# paths./api/v4/hooks/outgoing/{hook_id}.delete.description
Delete an outgoing webhook given the hook id.
##### Permissions
`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.

# paths./api/v4/hooks/outgoing/{hook_id}.put.description
Update an outgoing webhook given the hook id.
##### Permissions
`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.

# paths./api/v4/hooks/outgoing/{hook_id}.put.requestBody.content.application/json.schema.properties.channel_id.description
The ID of a public channel or private group that receives the webhook payloads.

# paths./api/v4/hooks/outgoing/{hook_id}.put.requestBody.content.application/json.schema.properties.display_name.description
The display name for this incoming webhook

# paths./api/v4/hooks/outgoing/{hook_id}.put.requestBody.content.application/json.schema.properties.description.description
The description for this incoming webhook

# paths./api/v4/hooks/outgoing/{hook_id}/regen_token.post.summary
Regenerate the token for the outgoing webhook.

# paths./api/v4/hooks/outgoing/{hook_id}/regen_token.post.description
Regenerate the token for the outgoing webhook.
##### Permissions
`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.

# paths./api/v4/groups.get.description
Retrieve a list of all groups not associated to a particular channel or team.

`not_associated_to_team` **OR** `not_associated_to_channel` is required.

If you use `not_associated_to_team`, you must be a team admin for that particular team (permission to manage that team).

If you use `not_associated_to_channel`, you must be a channel admin for that particular channel (permission to manage that channel).

n

# paths./api/v4/groups.get.parameters[].description
String to pattern match the `name` and `display_name` field. Will return all groups whose `name` and `display_name` field match any of the text.

# paths./api/v4/groups.get.parameters[].description
Boolean which adds the `member_count` attribute to each group JSON object

# paths./api/v4/groups.get.parameters[].description
Team GUID which is used to return all the groups not associated to this team

# paths./api/v4/groups.get.parameters[].description
Group GUID which is used to return all the groups not associated to this channel

# paths./api/v4/groups.get.parameters[].description
Only return groups that have been modified since the given Unix timestamp (in milliseconds). All modified groups, including deleted and created groups, will be returned.
n

# paths./api/v4/groups.get.parameters[].description
Boolean which filters the group entries with the `allow_reference` attribute set.

# paths./api/v4/channels/{channel_id}/groups.get.description
Retrieve the list of groups associated with a given channel.

##### Permissions
Must have `manage_system` permission.

# paths./api/v4/channels/{channel_id}/groups.get.parameters[].description
Boolean which filters the group entries with the `allow_reference` attribute set.

# paths./api/v4/teams/{team_id}/groups.get.description
Retrieve the list of groups associated with a given team.

# paths./api/v4/teams/{team_id}/groups.get.parameters[].description
Boolean which filters in the group entries with the `allow_reference` attribute set.

# paths./api/v4/teams/{team_id}/groups_by_channels.get.description
Retrieve the set of groups associated with the channels in the given team grouped by channel.

##### Permissions
Must have `manage_system` permission or can access only for current user

# paths./api/v4/teams/{team_id}/groups_by_channels.get.parameters[].description
Boolean which filters in the group entries with the `allow_reference` attribute set.

# paths./api/v4/teams/{team_id}/groups_by_channels.get.parameters[].description
Boolean to determine whether the pagination should be applied or not

# paths./api/v4/users/{user_id}/groups.get.description
Retrieve the list of groups associated to the user

# paths./api/v4/commands.post.description
Create a command for a team.
##### Permissions
`manage_slash_commands` for the team the command is in.

# paths./api/v4/commands.post.requestBody.content.application/json.schema.properties.team_id.description
Team ID to where the command should be created

# paths./api/v4/commands.post.requestBody.content.application/json.schema.properties.method.description
`'P'` for post request, `'G'` for get request

# paths./api/v4/commands.post.requestBody.content.application/json.schema.properties.url.description
The URL that the command will make the request

# paths./api/v4/commands.get.description
List commands for a team.
##### Permissions
`manage_slash_commands` if need list custom commands.

# paths./api/v4/commands.get.parameters[].description
To get only the custom commands. If set to false will get the custom
if the user have access plus the system commands, otherwise just the system commands.

# paths./api/v4/teams/{team_id}/commands/autocomplete.get.description
List autocomplete commands in the team.
##### Permissions
`view_team` for the team.

# paths./api/v4/teams/{team_id}/commands/autocomplete_suggestions.get.description
List commands' autocomplete data for the team.
##### Permissions
`view_team` for the team.

# paths./api/v4/teams/{team_id}/commands/autocomplete_suggestions.get.responses.200.description
Commands' autocomplete data retrieval successful

# paths./api/v4/commands/{command_id}.get.description
Get a command definition based on command id string.
##### Permissions
Must have `manage_slash_commands` permission for the team the command is in.

# paths./api/v4/commands/{command_id}.put.description
Update a single command based on command id string and Command struct.
##### Permissions
Must have `manage_slash_commands` permission for the team the command is in.

# paths./api/v4/commands/{command_id}.delete.description
Delete a command based on command id string.
##### Permissions
Must have `manage_slash_commands` permission for the team the command is in.

# paths./api/v4/commands/{command_id}/regen_token.put.description
Generate a new token for the command based on command id string.
##### Permissions
Must have `manage_slash_commands` permission for the team the command is in.

# paths./api/v4/commands/{command_id}/regen_token.put.parameters[].description
ID of the command to generate the new token

# paths./api/v4/commands/execute.post.description
Execute a command on a team.
##### Permissions
Must have `use_slash_commands` permission for the team the command is in.

# paths./api/v4/commands/execute.post.requestBody.content.application/json.schema.properties.channel_id.description
Channel Id where the command will execute

# paths./api/v4/commands/execute.post.requestBody.content.application/json.schema.properties.command.description
The slash command to execute, including parameters. Eg, `'/echo bounces around the room'`

# paths./api/v4/roles.get.description
##### Permissions

`manage_system` permission is required.

# paths./api/v4/roles/{role_id}.get.description
Get a role from the provided role id.

##### Permissions
Requires an active session but no other permissions.

# paths./api/v4/roles/name/{role_name}.get.description
Get a role from the provided role name.

##### Permissions
Requires an active session but no other permissions.

# paths./api/v4/roles/names.post.description
Get a list of roles from their names.

##### Permissions
Requires an active session but no other permissions.

# paths./api/v4/reactions.post.description
Create a reaction.
##### Permissions
Must have `read_channel` permission for the channel the post is in.

# paths./api/v4/reactions.post.requestBody.description
The user's reaction with its post_id, user_id, and emoji_name fields set

# paths./api/v4/posts/{post_id}/reactions.get.description
Get a list of reactions made by all users to a given post.
##### Permissions
Must have `read_channel` permission for the channel the post is in.

# paths./api/v4/users/{user_id}/posts/{post_id}/reactions/{emoji_name}.delete.description
Deletes a reaction made by a user from the given post.
##### Permissions
Must be user or have `manage_system` permission.

# paths./api/v4/bots.post.description
Create a new bot account on the system. Username is required.
##### Permissions
Must have `create_bot` permission.

# paths./api/v4/bots.get.description
Get a page of a list of bots.
##### Permissions
Must have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing.

# paths./api/v4/bots.get.parameters[].description
The number of users per page. There is a maximum limit of 200 users per page.

# paths./api/v4/bots.get.parameters[].description
When true, only orphaned bots will be returned. A bot is consitered orphaned if it's owner has been deactivated.

# paths./api/v4/bots/{bot_user_id}.put.description
Partially update a bot by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.
##### Permissions
Must have `manage_bots` permission. 

# paths./api/v4/bots/{bot_user_id}.get.description
Get a bot specified by its bot id.
##### Permissions
Must have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing.

# paths./api/v4/bots/{bot_user_id}/disable.post.description
Disable a bot.
##### Permissions
Must have `manage_bots` permission. 

# paths./api/v4/bots/{bot_user_id}/enable.post.description
Enable a bot.
##### Permissions
Must have `manage_bots` permission. 

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.description
OpenAI compatible chat completion, see the <a href="https://platform.openai.com/docs/api-reference/chat/create">OpenAI documentation</a>.
<br><br>
Multimodal (eg text and image) and function calling are available depending on the model.
<br><br>
List of models available on this endpoint could be retrieve with [GET `/2/ai/{product_id}/openai/v1/models`](/docs/api/get/2/ai/{product_id}/openai/v1/models).
<br><br>
Some models are in **beta** and may being subject to changes,
use [GET `/1/ai/models`](/docs/api/get/1/ai/models) to check what model are in **beta**
and see our [General Terms and Conditions](https://www.infomaniak.com/gtl/rgpd.documents).

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.logit_bias.description
Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.logprobs.description
Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.max_completion_tokens.description
An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.messages.items.description
A list of messages comprising the conversation so far.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.model.description
Model name used to generate the response, like `qwen3` or `swiss-ai/Apertus-70B-Instruct-2509`. Infomaniak offers a wide range of models with different capabilities, performance characteristics, and price points. Use the endpoint [GET `/1/ai/models`](/docs/api/get/1/ai/models) to retrieve the models list with various informations.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.n.description
Unused
How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.parallel_tool_calls.description
Defaults to true
Whether to enable parallel function calling during tool use.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.presence_penalty.description
Defaults to 0
The number should be above -2.0 but below 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.reasoning_effort.description
Currently, it only allows to enable/disable the thinking: `"none"` disables the thinking, any other value enables the thinking.
By default, the thinking is enabled on most models.
The thinking is not supported by all the models, for instance neither `apertus-ai/Apertus-v1.5-70B` nor `mistral3` support it.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.response_format.properties.json_schema.properties.description.description
A description of what the response format is for, used by the model to determine how to respond in the format.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.response_format.properties.json_schema.properties.name.description
The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.response_format.properties.json_schema.properties.schema.description
The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.response_format.properties.json_schema.properties.strict.description
Defaults to false
Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.response_format.properties.json_schema.description
Required only if type is json_schema.
Structured Outputs configuration options, including a JSON Schema.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.response_format.properties.type.description
The type of response format being defined.<br>**NOTE:** only `json_schema` is currently supported, `text` is the default behavior and should not be given, `json_object` is obsolete and is no longer supported.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.response_format.description
An object specifying the format that the model must output.
Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.
Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.seed.description
Deprecated
This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.stop.description
Defaults to null
Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.stream.description
Defaults to true
If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the OpenAI streaming section for more information, along with the OpenAI streaming responses guide for more information on how to handle the streaming events.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.stream_options.properties.include_obfuscation.description
When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.stream_options.properties.include_usage.description
If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array.
All other chunks will also include a usage field, but with a null value. NOTE: If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.stream_options.description
Defaults to null
Options for streaming response. Only set this when you set stream: true.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.temperature.description
Defaults to 1
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.tool_choice.description
Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
none is the default when no tools are present. auto is the default if tools are present.See the OpenAI documentation about tool_choice.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.tools.description
A list of tools the model may call. You can provide either custom tools or function tools.
See the OpenAI documentation about tools.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.top_logprobs.description
An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.top_p.description
Defaults to 1
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
We generally recommend altering this or temperature but not both.

# paths./2/ai/{product_id}/openai/v1/chat/completions.post.requestBody.content.application/json.schema.properties.user.description
Deprecated
This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse.

# paths./2/vod/accounts/{account}/channels.get.description
Retrieves a paginated list of channels associated with the provided account.

# paths./2/vod/accounts/{account}/channels.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}.get.description
Retrieves details of a specified channel.

# paths./2/vod/channels/{channel}/callbacks.get.description
Retrieves a paginated list of callbacks associated with the provided channel.

# paths./2/vod/channels/{channel}/callbacks.post.description
Creates a new callback within the provided channel based on the provided parameters.

# paths./2/vod/channels/{channel}/callbacks.post.requestBody.content.application/json.schema.properties.active.description
Indicates whether the Callback is active

# paths./2/vod/channels/{channel}/callbacks.post.requestBody.content.application/json.schema.properties.event_list.description
The list of supported events for Callback

# paths./2/vod/channels/{channel}/disk-usage.get.parameters[].description
This field must be present and not empty unless the `pack` field is equal to any of the following:`1jhvl2upwockt`, `1jijk03u32izh`

# paths./2/vod/channels/{channel}/disk-usage.get.parameters[].schema.description
This field must be present and not empty unless the `pack` field is equal to any of the following:`1jhvl2upwockt`, `1jijk03u32izh`

# paths./2/vod/channels/{channel}/disk-usage.get.parameters[].description
This field must be present and not empty if the `pack` field is equal to any of the following:`custom`

# paths./2/vod/channels/{channel}/disk-usage.get.parameters[].schema.description
This field must be present and not empty if the `pack` field is equal to any of the following:`custom`

# paths./2/vod/channels/{channel}/disk-usage.get.parameters[].schema.description
Any valid byte unit, with or without precision specified (tries to format bytes in the most readable unit if nothing is specified):
YB: Yotta Byte ZB: Zetta Byte EB: Exa Byte PB: Peta Byte TB: Tera Byte GB: Giga Byte MB: Mega Byte kB: Kilo Byte B: Byte no: No formatting (raw number of bytes)A precision (digits after '.') may be added with the following notation:
6: 1.322123MB/6: 1.322123MB MB/6: 1.322123MB MB/000000: 1.322123MB GB/9: 0.001322123GB

# paths./2/vod/channels/{channel}/disk-usage/trash.get.description
Retrieves the disk usage of the trash for a channel.

# paths./2/vod/channels/{channel}/disk-usage/trash.get.parameters[].description
This field must be present and not empty unless the `pack` field is equal to any of the following:`1jhvl2upwockt`, `1jijk03u32izh`

# paths./2/vod/channels/{channel}/disk-usage/trash.get.parameters[].schema.description
This field must be present and not empty unless the `pack` field is equal to any of the following:`1jhvl2upwockt`, `1jijk03u32izh`

# paths./2/vod/channels/{channel}/disk-usage/trash.get.parameters[].description
This field must be present and not empty if the `pack` field is equal to any of the following:`custom`

# paths./2/vod/channels/{channel}/disk-usage/trash.get.parameters[].schema.description
This field must be present and not empty if the `pack` field is equal to any of the following:`custom`

# paths./2/vod/channels/{channel}/disk-usage/trash.get.parameters[].schema.description
Any valid byte unit, with or without precision specified (tries to format bytes in the most readable unit if nothing is specified):
YB: Yotta Byte ZB: Zetta Byte EB: Exa Byte PB: Peta Byte TB: Tera Byte GB: Giga Byte MB: Mega Byte kB: Kilo Byte B: Byte no: No formatting (raw number of bytes)A precision (digits after '.') may be added with the following notation:
6: 1.322123MB/6: 1.322123MB MB/6: 1.322123MB MB/000000: 1.322123MB GB/9: 0.001322123GB

# paths./2/vod/disk-usage/{folder}.get.parameters[].description
This field must be present and not empty unless the `pack` field is equal to any of the following:`1jhvl2upwockt`, `1jijk03u32izh`

# paths./2/vod/disk-usage/{folder}.get.parameters[].schema.description
This field must be present and not empty unless the `pack` field is equal to any of the following:`1jhvl2upwockt`, `1jijk03u32izh`

# paths./2/vod/disk-usage/{folder}.get.parameters[].description
This field must be present and not empty if the `pack` field is equal to any of the following:`custom`

# paths./2/vod/disk-usage/{folder}.get.parameters[].schema.description
This field must be present and not empty if the `pack` field is equal to any of the following:`custom`

# paths./2/vod/disk-usage/{folder}.get.parameters[].schema.description
Any valid byte unit, with or without precision specified (tries to format bytes in the most readable unit if nothing is specified):
YB: Yotta Byte ZB: Zetta Byte EB: Exa Byte PB: Peta Byte TB: Tera Byte GB: Giga Byte MB: Mega Byte kB: Kilo Byte B: Byte no: No formatting (raw number of bytes)A precision (digits after '.') may be added with the following notation:
6: 1.322123MB/6: 1.322123MB MB/6: 1.322123MB MB/000000: 1.322123MB GB/9: 0.001322123GB

# paths./2/vod/channels/{channel}/browse.get.description
Retrieves a paginated list of files associated with the provided channel and located at in its root directory.

# paths./2/vod/channels/{channel}/browse.get.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Bvf</note>

# paths./2/vod/channels/{channel}/browse.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/browse.delete.description
Discards the specified file associated with the provided channel based on the provided parameters.

# paths./2/vod/channels/{channel}/browse.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Bvf</note>

# paths./2/vod/channels/{channel}/browse/tree.get.description
Retrieves the tree structure of the root directory for the provided channel.

# paths./2/vod/channels/{channel}/browse/breadcrumb.get.description
Retrieves the breadcrumb trail of the root directory for the provided channel.

# paths./2/vod/channels/{channel}/browse/trash.get.description
Retrieves a paginated list of files located in the trash associated with the requested channel..

# paths./2/vod/channels/{channel}/browse/trash.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/browse/trash.delete.description
Empties the trash for the provided channel based on the provided parameters.

# paths./2/vod/channels/{channel}/browse/trash.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Bvf</note>

# paths./2/vod/browse/{folder}.get.description
Retrieves a paginated list of files associated with the provided channel and located at in the requested directory.

# paths./2/vod/browse/{folder}.get.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Bvf</note>

# paths./2/vod/browse/{folder}/breadcrumb.get.description
Retrieves the breadcrumb trail of a specified folder.

# paths./2/vod/browse/{folder}/tree.get.description
Retrieves the tree structure of a specified folder.

# paths./2/vod/samples.get.description
Retrieves all media from the demo channel.

# paths./2/vod/categories.get.description
Get a paginated list of the available media categories.

# paths./2/vod/categories.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/countries.get.description
Retrieves a paginated list of countries.

# paths./2/vod/countries.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/lang.get.description
Retrieves a paginated list of languages.

# paths./2/vod/lang.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/lang/{lang}.get.description
Retrieves details of a specified language.

# paths./2/vod/channels/{channel}/alerts.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/alerts.post.description
Creates a new alert configuration for the provided channel.

# paths./2/vod/channels/{channel}/alerts.post.requestBody.content.application/json.schema.properties.days.items.description
monday: tuesday: wednesday: thursday: friday: saturday: sunday:

# paths./2/vod/channels/{channel}/alerts.post.requestBody.content.application/json.schema.properties.days.description
The days of the week when the Alert should be triggered

# paths./2/vod/channels/{channel}/alerts.post.requestBody.content.application/json.schema.properties.transports.items.description
phone: Send notifications by phone email: Send notifications by email

# paths./2/vod/channels/{channel}/alerts.post.requestBody.content.application/json.schema.properties.transports.description
The transports used to deliver the Alert

# paths./2/vod/alerts/{alert}.put.description
Updates the configuration of the specified alert.

# paths./2/vod/alerts/{alert}.put.requestBody.content.application/json.schema.properties.days.items.description
monday: tuesday: wednesday: thursday: friday: saturday: sunday:

# paths./2/vod/alerts/{alert}.put.requestBody.content.application/json.schema.properties.days.description
The days of the week when the Alert should be triggered

# paths./2/vod/alerts/{alert}.put.requestBody.content.application/json.schema.properties.transports.items.description
phone: Send notifications by phone email: Send notifications by email

# paths./2/vod/alerts/{alert}.put.requestBody.content.application/json.schema.properties.transports.description
The transports used to deliver the Alert

# paths./2/vod/alerts/{alert}.delete.description
Deletes the specified alert configuration.

# paths./2/vod/callbacks/{callback}.get.description
Retrieves details of a specified callback.

# paths./2/vod/callbacks/{callback}.put.description
Updates details of a specified callback based on the provided parameters.

# paths./2/vod/callbacks/{callback}.put.requestBody.content.application/json.schema.properties.active.description
Indicates whether the Callback is active

# paths./2/vod/callbacks/{callback}.put.requestBody.content.application/json.schema.properties.event_list.description
The list of supported events for Callback

# paths./2/vod/channels/{channel}/players.get.description
Retrieves a paginated list of players associated with the provided channel.

# paths./2/vod/channels/{channel}/players.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/players.post.description
Creates a new player within the provided channel based on the parameters.

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.ads_category.description
vast: The advertisement is from a vast video: The advertisement is from a video none: There is no advertisement

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.auto_hide_controls.description
Indicates whether controls should automatically hide for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.auto_start.description
Indicates whether media should start automatically for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.chromecast.description
Indicates whether Chromecast is enabled for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.default.description
Indicates whether the Player is set as default

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.default_speed.description
The default speed of playback for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.enable_embed_code.description
Indicates whether embed code is enabled for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.enable_facebook.description
Indicates whether Facebook sharing is enabled for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.enable_twitter.description
Indicates whether Twitter sharing is enabled for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.encoding_change_enabled.description
Indicates whether encoding change is enabled for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.force_media_ratio.description
Indicates whether media ratio is enforced for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.force_subtitles_type.description
lang_navigator: The subtitles will try to match the browser lang lang_manager: Force the subtitles will try to match the manager lang

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.geoip_image.description
The GeoIP image associated with the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.interrupt_image.description
The interrupt image associated with the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.is360.description
Indicates whether the Player supports 360-degree videos

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.is_default.description
Indicates if the Player is the default one when sharing

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.logo_anchor.description
The anchor of the overlay logotop_left: Positioned at the top-left corner top_right: Positioned at the top-right corner bottom_left: Positioned at the bottom-left corner bottom_right: Positioned at the bottom-right corner center: Positioned at the center of the container or screen none: Not positioned on the container or screen

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.logo_image.description
The logo image associated with the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.logo_margin_horizontal.description
The horizontal margin of the Player logo

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.media_thumbnail_anchor.description
The media thumbnail anchortop: Positioned on top left: Positioned on the left side

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.player_end_screen_type.description
pause_and_replay: We will show pause and replay buttons auto_loop: The video will automatically loop suggest_more_media: Will suggest many video as ending screen suggest_next_media: Will suggest one video as ending screen

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.preferred_playback_strategy.description
The preferred playback strategy (may not be enforced)hls: Apple HTTP Live Streaming dash: Dynamic Adaptive Streaming over HTTP single: Single bitrate best: Playback strategy selecting the best available quality dynamically

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.preload_image.description
The preload image associated with the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.restrict_image.description
The restrict image associated with the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_audio.description
Indicates whether audio controls should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_controls.description
Indicates whether controls should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_default_logo.description
Indicates whether the default logo should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_duration.description
Indicates whether the duration should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_fullscreen.description
Indicates whether fullscreen controls should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_loop.description
Indicates whether loop controls should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_media_info.description
Indicates whether media information should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_media_thumbnail.description
Indicates whether media thumbnail should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_progression.description
Indicates whether progression controls should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_related.description
Indicates whether related media should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_replay.description
Indicates whether replay controls should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_speed.description
Indicates whether speed controls should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_viewers.description
Indicates whether viewers count should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_viewers_after.description
The time after which viewers count should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.show_viewers_only_after.description
The time only after which viewers count should be shown for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.skip_intro_to.description
Number of seconds to reach once the "skip intro" button is pressed, nothing will appear if value is 0

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.suggestions.properties.type.description
Type of media to be played after the current onesimilar_tags: Items with similar tags or metadata last_uploaded: Items sorted by the time of their last upload most_viewed: Items sorted by the number of views, descending least_viewed: Items sorted by the number of views, ascending random: Items sorted randomly alphabetical: Items sorted randomly

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.suggestions.description
a list media sources to play at the end of current media

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.time_before_hide_cb.description
The time before controls should be hidden for the Player

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.time_skip_mode.description
none: No rewind mode selected forward_only: Forward only mode selected rewind_only: Rewind only mode selected rewind_forward: Rewind and forward mode selected

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.twitter_related.items.description
A word or phrase preceded by a hash (#) to identify digital content on a specific topic on social media sites.

# paths./2/vod/channels/{channel}/players.post.requestBody.content.application/json.schema.properties.twitter_related.description
The related Twitter account associated with the Player

# paths./2/vod/channels/{channel}/players.delete.description
Deletes players associated with the provided channel.

# paths./2/vod/channels/{channel}/players.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Player</note>

# paths./2/vod/players/{player}.get.description
Retrieves details of a specified player.

# paths./2/vod/players/{player}.put.description
Updates details of a specified player based on the parameters.

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.ads_category.description
vast: The advertisement is from a vast video: The advertisement is from a video none: There is no advertisement

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.auto_hide_controls.description
Indicates whether controls should automatically hide for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.auto_start.description
Indicates whether media should start automatically for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.chromecast.description
Indicates whether Chromecast is enabled for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.default.description
Indicates whether the Player is set as default

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.default_speed.description
The default speed of playback for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.enable_embed_code.description
Indicates whether embed code is enabled for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.enable_facebook.description
Indicates whether Facebook sharing is enabled for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.enable_twitter.description
Indicates whether Twitter sharing is enabled for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.encoding_change_enabled.description
Indicates whether encoding change is enabled for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.force_media_ratio.description
Indicates whether media ratio is enforced for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.force_subtitles_type.description
lang_navigator: The subtitles will try to match the browser lang lang_manager: Force the subtitles will try to match the manager lang

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.geoip_image.description
The GeoIP image associated with the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.interrupt_image.description
The interrupt image associated with the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.is360.description
Indicates whether the Player supports 360-degree videos

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.is_default.description
Indicates if the Player is the default one when sharing

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.logo_anchor.description
The anchor of the overlay logotop_left: Positioned at the top-left corner top_right: Positioned at the top-right corner bottom_left: Positioned at the bottom-left corner bottom_right: Positioned at the bottom-right corner center: Positioned at the center of the container or screen none: Not positioned on the container or screen

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.logo_image.description
The logo image associated with the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.logo_margin_horizontal.description
The horizontal margin of the Player logo

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.media_thumbnail_anchor.description
The media thumbnail anchortop: Positioned on top left: Positioned on the left side

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.player_end_screen_type.description
pause_and_replay: We will show pause and replay buttons auto_loop: The video will automatically loop suggest_more_media: Will suggest many video as ending screen suggest_next_media: Will suggest one video as ending screen

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.preferred_playback_strategy.description
The preferred playback strategy (may not be enforced)hls: Apple HTTP Live Streaming dash: Dynamic Adaptive Streaming over HTTP single: Single bitrate best: Playback strategy selecting the best available quality dynamically

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.preload_image.description
The preload image associated with the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.restrict_image.description
The restrict image associated with the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_audio.description
Indicates whether audio controls should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_controls.description
Indicates whether controls should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_default_logo.description
Indicates whether the default logo should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_duration.description
Indicates whether the duration should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_fullscreen.description
Indicates whether fullscreen controls should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_loop.description
Indicates whether loop controls should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_media_info.description
Indicates whether media information should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_media_thumbnail.description
Indicates whether media thumbnail should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_progression.description
Indicates whether progression controls should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_related.description
Indicates whether related media should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_replay.description
Indicates whether replay controls should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_speed.description
Indicates whether speed controls should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_viewers.description
Indicates whether viewers count should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_viewers_after.description
The time after which viewers count should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.show_viewers_only_after.description
The time only after which viewers count should be shown for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.skip_intro_to.description
Number of seconds to reach once the "skip intro" button is pressed, nothing will appear if value is 0

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.suggestions.properties.type.description
Type of media to be played after the current onesimilar_tags: Items with similar tags or metadata last_uploaded: Items sorted by the time of their last upload most_viewed: Items sorted by the number of views, descending least_viewed: Items sorted by the number of views, ascending random: Items sorted randomly alphabetical: Items sorted randomly

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.suggestions.description
a list media sources to play at the end of current media

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.time_before_hide_cb.description
The time before controls should be hidden for the Player

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.time_skip_mode.description
none: No rewind mode selected forward_only: Forward only mode selected rewind_only: Rewind only mode selected rewind_forward: Rewind and forward mode selected

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.twitter_related.items.description
A word or phrase preceded by a hash (#) to identify digital content on a specific topic on social media sites.

# paths./2/vod/players/{player}.put.requestBody.content.application/json.schema.properties.twitter_related.description
The related Twitter account associated with the Player

# paths./2/vod/players/{player}.delete.description
Deletes the specified player.
Note that in case the player is attached to a share link, the latter will be re-assigned to a fallback player.

# paths./2/vod/channels/{channel}/folders/root.get.description
Retrieves details of the root folder associated with the provided channel.

# paths./2/vod/channels/{channel}/folders.get.description
Retrieves a paginated list of folders associated with the provided channel.

# paths./2/vod/channels/{channel}/folders.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/folders.post.description
Creates a new folder within the provided channel based on the provided parameters.

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.allowed_country.items.description
ISO 3166-1 country identifier (or name), may be one of the following:
alpha2: Two-letter country code. alpha3: Three-letter country code. name: Country english short name.

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.allowed_country.description
List of allowed countries by country code for the Folder

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.allowed_domains.items.description
a valid domain name or URL that has either a valid A or an AAAA dns record

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.allowed_ip.items.description
Any valid Ipv4, Ipv6, Ip range or CIDR notation address:
2001:0db8:0000:85a3:0000:0000:ac1f:8001: IPv6. 192.168.21.1: IPv4. 198.51.100.14/24: CIDR notation. 198.51.100.14-198.51.100.255: Ip range notation.

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.auto_generate_description.description
Automatically generates a description with AI api for media uploaded in this Folder

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.auto_generate_subtitle.description
Automatically generates subtitles with AI api for media uploaded in this Folder

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.auto_generate_title.description
Automatically generates a title with AI api for media uploaded in this Folder

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.auto_publish.description
Indicates whether media in the Folder is automatically published

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.auto_translate_languages.description
Automatically generate a list of subtitles with AI api in the given language(s) for media uploaded in this Folder

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.auto_validate.description
Indicates whether media uploaded to this folder should be marked as validated automatically

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.disallowed_country.items.description
ISO 3166-1 country identifier (or name), may be one of the following:
alpha2: Two-letter country code. alpha3: Three-letter country code. name: Country english short name.

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.disallowed_country.description
List of disallowed countries by country code for the Folder

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.disallowed_domains.items.description
a valid domain name or URL that has either a valid A or an AAAA dns record

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.disallowed_domains.description
List of disallowed domains for the Folder

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.disallowed_ip.items.description
Any valid Ipv4, Ipv6, Ip range or CIDR notation address:
2001:0db8:0000:85a3:0000:0000:ac1f:8001: IPv6. 192.168.21.1: IPv4. 198.51.100.14/24: CIDR notation. 198.51.100.14-198.51.100.255: Ip range notation.

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.disallowed_ip.description
List of disallowed IP addresses for the Folder

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.encodings.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Encoding</note>

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.inherits_encodings.description
Indicates whether the Folder inherits encodings from its parent

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.inherits_media_processing.description
Indicates whether the Folder inherits media processing settings from its parent

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.inherits_restrictions.description
Defines whether or not the resource inherits restrictions settings

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.key_restricted.description
Indicates whether the Folder is restricted with a key

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.name.description
A valid filename without any file system reserved or control characters

# paths./2/vod/channels/{channel}/folders.post.requestBody.content.application/json.schema.properties.replace_on_upload.description
Indicates whether existing media is replaced upon upload

# paths./2/vod/folders/{folder}.get.description
Retrieves details of a specified folder.

# paths./2/vod/folders/{folder}.put.description
Updates details of a specified folder based on the provided parameters.

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.allowed_country.items.description
ISO 3166-1 country identifier (or name), may be one of the following:
alpha2: Two-letter country code. alpha3: Three-letter country code. name: Country english short name.

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.allowed_country.description
List of allowed countries by country code for the Folder

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.allowed_domains.items.description
a valid domain name or URL that has either a valid A or an AAAA dns record

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.allowed_ip.items.description
Any valid Ipv4, Ipv6, Ip range or CIDR notation address:
2001:0db8:0000:85a3:0000:0000:ac1f:8001: IPv6. 192.168.21.1: IPv4. 198.51.100.14/24: CIDR notation. 198.51.100.14-198.51.100.255: Ip range notation.

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.auto_generate_description.description
Automatically generates a description with AI api for media uploaded in this Folder

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.auto_generate_subtitle.description
Automatically generates subtitles with AI api for media uploaded in this Folder

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.auto_generate_title.description
Automatically generates a title with AI api for media uploaded in this Folder

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.auto_publish.description
Indicates whether media in the Folder is automatically published

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.auto_translate_languages.description
Automatically generate a list of subtitles with AI api in the given language(s) for media uploaded in this Folder

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.auto_validate.description
Indicates whether media uploaded to this folder should be marked as validated automatically

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.disallowed_country.items.description
ISO 3166-1 country identifier (or name), may be one of the following:
alpha2: Two-letter country code. alpha3: Three-letter country code. name: Country english short name.

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.disallowed_country.description
List of disallowed countries by country code for the Folder

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.disallowed_domains.items.description
a valid domain name or URL that has either a valid A or an AAAA dns record

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.disallowed_domains.description
List of disallowed domains for the Folder

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.disallowed_ip.items.description
Any valid Ipv4, Ipv6, Ip range or CIDR notation address:
2001:0db8:0000:85a3:0000:0000:ac1f:8001: IPv6. 192.168.21.1: IPv4. 198.51.100.14/24: CIDR notation. 198.51.100.14-198.51.100.255: Ip range notation.

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.disallowed_ip.description
List of disallowed IP addresses for the Folder

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.encodings.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Encoding</note>

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.inherits_encodings.description
Indicates whether the Folder inherits encodings from its parent

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.inherits_media_processing.description
Indicates whether the Folder inherits media processing settings from its parent

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.inherits_restrictions.description
Defines whether or not the resource inherits restrictions settings

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.key_restricted.description
Indicates whether the Folder is restricted with a key

# paths./2/vod/folders/{folder}.put.requestBody.content.application/json.schema.properties.replace_on_upload.description
Indicates whether existing media is replaced upon upload

# paths./2/vod/folders/{folder}/upload/endpoint.get.description
Generate a temporary signed URL for uploading files to the given folder.

# paths./2/vod/players/{player}/ads.get.description
Retrieves a paginated list of advertisements associated with the provided player.

# paths./2/vod/players/{player}/ads.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/players/{player}/ads.post.description
Creates a new advertisement associated with the provided player.

# paths./2/vod/players/{player}/ads.post.requestBody.content.application/json.schema.properties.category.description
The category of {name}vast: The advertisement is from a vast video: The advertisement is from a video none: There is no advertisement

# paths./2/vod/players/{player}/ads.post.requestBody.content.application/json.schema.properties.offset.description
The offset after which the Ad gets loaded

# paths./2/vod/players/{player}/ads.post.requestBody.content.application/json.schema.properties.skip_after.description
The time in seconds after which the Ad can be skipped

# paths./2/vod/players/{player}/ads.post.requestBody.content.application/json.schema.properties.type.description
The type of {name}pre_roll: Advertisement displayed before the main content mid_roll: Advertisement displayed during the main content pst_roll: Advertisement displayed after the main content

# paths./2/vod/players/{player}/ads.delete.description
Deletes the specified list of advertisements associated with the provided player.

# paths./2/vod/players/{player}/ads.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Ad</note>

# paths./2/vod/ads/{ad}.put.description
Updates details of a specified advertisement based on the provided parameters.

# paths./2/vod/ads/{ad}.put.requestBody.content.application/json.schema.properties.category.description
The category of {name}vast: The advertisement is from a vast video: The advertisement is from a video none: There is no advertisement

# paths./2/vod/ads/{ad}.put.requestBody.content.application/json.schema.properties.offset.description
The offset after which the Ad gets loaded

# paths./2/vod/ads/{ad}.put.requestBody.content.application/json.schema.properties.skip_after.description
The time in seconds after which the Ad can be skipped

# paths./2/vod/ads/{ad}.put.requestBody.content.application/json.schema.properties.type.description
The type of {name}pre_roll: Advertisement displayed before the main content mid_roll: Advertisement displayed during the main content pst_roll: Advertisement displayed after the main content

# paths./2/vod/media/{media}/subtitles.get.description
Retrieves a paginated list of subtitles associated with the provided media.

# paths./2/vod/media/{media}/subtitles.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/media/{media}/subtitles.post.description
Creates a new subtitle within the provided media based on the provided parameters.

# paths./2/vod/media/{media}/subtitles.post.requestBody.content.application/json.schema.properties.default.description
Indicates whether the Subtitle is set as default

# paths./2/vod/media/{media}/subtitles.post.requestBody.content.application/json.schema.properties.file.description
A valid subtitle file without XSS injections

# paths./2/vod/media/{media}/subtitles.post.requestBody.content.application/json.schema.properties.lines.description
An array of subtitle lines, each containing valid start/end/lines keys

# paths./2/vod/media/{media}/subtitles.post.requestBody.content.application/json.schema.properties.name.description
A valid filename that does not include slashes, dots or non printable characters

# paths./2/vod/media/{media}/subtitles.post.requestBody.content.application/json.schema.properties.published.description
Indicates whether the Subtitle is publicly accessible

# paths./2/vod/media/{media}/subtitles.delete.description
Deletes the specified list of subtitles associated with the provided player.

# paths./2/vod/media/{media}/subtitles.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Subtitle</note>

# paths./2/vod/subtitles/{subtitle}.get.description
Retrieves details of a specified subtitle.

# paths./2/vod/subtitles/{subtitle}.put.description
Updates details of a specified subtitle based on the provided parameters.

# paths./2/vod/subtitles/{subtitle}.put.requestBody.content.application/json.schema.properties.default.description
Indicates whether the Subtitle is set as default

# paths./2/vod/subtitles/{subtitle}.put.requestBody.content.application/json.schema.properties.lines.description
An array of subtitle lines, each containing valid start/end/lines keys

# paths./2/vod/subtitles/{subtitle}.put.requestBody.content.application/json.schema.properties.name.description
A valid filename that does not include slashes, dots or non printable characters

# paths./2/vod/subtitles/{subtitle}.put.requestBody.content.application/json.schema.properties.published.description
Indicates whether the Subtitle is publicly accessible

# paths./2/vod/channels/{channel}/playlists.get.description
Retrieves a paginated list of playlists associated with the provided channel.

# paths./2/vod/channels/{channel}/playlists.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/playlists/{playlist}/media.get.description
Retrieves a paginated list of media in the specified playlist.

# paths./2/vod/playlists/{playlist}/media.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/playlists/{playlist}.get.description
Retrieves details of a specified playlist.

# paths./2/vod/channels/{channel}/mixtapes.get.description
Retrieves a paginated list of mixtapes associated with the provided channel.

# paths./2/vod/channels/{channel}/mixtapes.get.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Mixtape</note>

# paths./2/vod/channels/{channel}/mixtapes.get.parameters[].schema.description
 Specify the order for the desired queried Media

# paths./2/vod/channels/{channel}/mixtapes.get.parameters[].schema.description
The type of {name}standard: Mixtape default: créée/éditée directement comme une mixtape classique generated: Mixtape produite dynamiquement par une autre application composite: Mixtape qui référence d’autres mixtape

# paths./2/vod/channels/{channel}/mixtapes.get.parameters[].schema.description
The {name} validity duration (in seconds)

# paths./2/vod/channels/{channel}/mixtapes.get.parameters[].schema.description
The strategy to apply for validity adjustmentonly_increase: Only increases the {model} validity if the requested duration is greater than the current one only_decrease: Only decreases the {model} validity if the requested duration is less than the current one

# paths./2/vod/channels/{channel}/mixtapes.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/mixtapes.post.description
Create a Mixtape matching request criteria.

# paths./2/vod/channels/{channel}/mixtapes.post.requestBody.content.application/json.schema.properties.mixtapes.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Mixtape</note>

# paths./2/vod/channels/{channel}/mixtapes.post.requestBody.content.application/json.schema.properties.order.description
 Specify the order for the desired queried Media

# paths./2/vod/channels/{channel}/mixtapes.post.requestBody.content.application/json.schema.properties.type.description
The type of {name}standard: Mixtape default: créée/éditée directement comme une mixtape classique generated: Mixtape produite dynamiquement par une autre application composite: Mixtape qui référence d’autres mixtape

# paths./2/vod/channels/{channel}/mixtapes.post.requestBody.content.application/json.schema.properties.validity.description
The {name} validity duration (in seconds)

# paths./2/vod/channels/{channel}/mixtapes.post.requestBody.content.application/json.schema.properties.validity_strategy.description
The strategy to apply for validity adjustmentonly_increase: Only increases the {model} validity if the requested duration is greater than the current one only_decrease: Only decreases the {model} validity if the requested duration is less than the current one

# paths./2/vod/mixtapes/{mixtape}.get.description
Retrieves details of a specified mixtape.

# paths./2/vod/mixtapes/{mixtape}.get.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Mixtape</note>

# paths./2/vod/mixtapes/{mixtape}.get.parameters[].schema.description
 Specify the order for the desired queried Media

# paths./2/vod/mixtapes/{mixtape}.get.parameters[].schema.description
The type of {name}standard: Mixtape default: créée/éditée directement comme une mixtape classique generated: Mixtape produite dynamiquement par une autre application composite: Mixtape qui référence d’autres mixtape

# paths./2/vod/mixtapes/{mixtape}.get.parameters[].schema.description
The {name} validity duration (in seconds)

# paths./2/vod/mixtapes/{mixtape}.get.parameters[].schema.description
The strategy to apply for validity adjustmentonly_increase: Only increases the {model} validity if the requested duration is greater than the current one only_decrease: Only decreases the {model} validity if the requested duration is less than the current one

# paths./2/vod/mixtapes/{mixtape}.put.requestBody.content.application/json.schema.properties.mixtapes.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Mixtape</note>

# paths./2/vod/mixtapes/{mixtape}.put.requestBody.content.application/json.schema.properties.order.description
 Specify the order for the desired queried Media

# paths./2/vod/mixtapes/{mixtape}.put.requestBody.content.application/json.schema.properties.type.description
The type of {name}standard: Mixtape default: créée/éditée directement comme une mixtape classique generated: Mixtape produite dynamiquement par une autre application composite: Mixtape qui référence d’autres mixtape

# paths./2/vod/mixtapes/{mixtape}.put.requestBody.content.application/json.schema.properties.validity.description
The {name} validity duration (in seconds)

# paths./2/vod/mixtapes/{mixtape}.put.requestBody.content.application/json.schema.properties.validity_strategy.description
The strategy to apply for validity adjustmentonly_increase: Only increases the {model} validity if the requested duration is greater than the current one only_decrease: Only decreases the {model} validity if the requested duration is less than the current one

# paths./2/vod/mixtapes/{mixtape}.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Mixtape</note>

# paths./2/vod/mixtapes/{mixtape}.delete.parameters[].schema.description
 Specify the order for the desired queried Media

# paths./2/vod/mixtapes/{mixtape}.delete.parameters[].schema.description
The type of {name}standard: Mixtape default: créée/éditée directement comme une mixtape classique generated: Mixtape produite dynamiquement par une autre application composite: Mixtape qui référence d’autres mixtape

# paths./2/vod/mixtapes/{mixtape}.delete.parameters[].schema.description
The {name} validity duration (in seconds)

# paths./2/vod/mixtapes/{mixtape}.delete.parameters[].schema.description
The strategy to apply for validity adjustmentonly_increase: Only increases the {model} validity if the requested duration is greater than the current one only_decrease: Only decreases the {model} validity if the requested duration is less than the current one

# paths./2/vod/mixtapes/{mixtape}/media.get.description
Retrieves a paginated list of media in the specified mixtape.

# paths./2/vod/mixtapes/{mixtape}/media.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/mixtapes/{mixtape}/media.put.description
Manually attaches media in the specified mixtape

# paths./2/vod/mixtapes/{mixtape}/media.delete.description
Manually detaches media in the specified mixtape

# paths./2/vod/media/{media}/chapters.get.description
Retrieves a paginated list of chapters assiociated with the provided media.

# paths./2/vod/media/{media}/chapters.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/chapters/{chapter}.get.description
Retrieves details of a specified chapter.

# paths./2/vod/chapters/{chapter}.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/encodings.get.description
Get a paginated list of encodings associated with the provided channel.

# paths./2/vod/channels/{channel}/encodings.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/encodings.post.description
Creates a new encoding for the provided channel based on the given parameters.

# paths./2/vod/channels/{channel}/encodings.post.requestBody.content.application/json.schema.properties.audio_channel.description
mono_1_0: Single-channel audio stereo_2_0: Two-channel audio stereo_2_1: Two-channel audio with subwoofer surround_4_1: Four-channel audio with subwoofer surround_5_1: Six-channel audio (5 speakers + subwoofer)surround_6_1: Seven-channel audio (6 speakers + subwoofer)surround_7_1: Eight-channel audio (7 speakers + subwoofer)

# paths./2/vod/channels/{channel}/encodings.post.requestBody.content.application/json.schema.properties.audio_codec.description
aac: Advanced Audio Coding he_aac: High-Efficiency Advanced Audio Coding flac: Free Lossless Audio Codec mp3: MPEG-1 Audio Layer III vorbis: Open-source audio compression format copy: Uncompressed, lossless audio codec opus: Versatile audio codec

# paths./2/vod/channels/{channel}/encodings.post.requestBody.content.application/json.schema.properties.container.description
flv: Adobe Flash Video container format m4a: MPEG-4 Audio container format mkv: Matroska Multimedia container format mp4: MPEG-4 Multimedia container format webm: WebM Multimedia container format mp3: MPEG-1 or MPEG-2 Audio Layer III audio container copy: Uncompressed, lossless container format aac: Advanced Audio Coding container format

# paths./2/vod/channels/{channel}/encodings.post.requestBody.content.application/json.schema.properties.copy.description
Indicates whether the Encoding is a pure copy

# paths./2/vod/channels/{channel}/encodings.post.requestBody.content.application/json.schema.properties.video_aspect.description
letterbox: Preserves aspect ratio with black bars stretch: Stretches content to fill screen fill: Expands content to fit screen keep_ratio: Maintains original aspect ratio copy: Matches aspect ratio of the source

# paths./2/vod/channels/{channel}/encodings.post.requestBody.content.application/json.schema.properties.video_codec.description
h264: Efficient video compression standard hevc: High-efficiency video coding technology theora: Open-source video compression format vp8: Google's video compression standard vp9: High-quality video compression codec copy: Uncompressed, lossless video codec h263: Video compression standard for low bitrates

# paths./2/vod/channels/{channel}/encodings.post.requestBody.content.application/json.schema.properties.video_fps.description
The video frames per second of the Encoding

# paths./2/vod/channels/{channel}/encodings.delete.description
Deletes encodings specified in the request associated with the provided channel.

# paths./2/vod/channels/{channel}/encodings.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Encoding</note>

# paths./2/vod/encodings/{encoding}.get.description
Retrieves details of a specified encoding.

# paths./2/vod/encodings/{encoding}.put.description
Updates details of a specified encoding based on the given parameters.

# paths./2/vod/encodings/constraints.get.description
List major encoding constraints that should be respected
in order to guarantee correct output encoding in most cases.

Still, following these rules may lead to incorrect encodings.
For example, trying to encode something into a flv container
will fail if the audio sampling rate is not 44100, 22050 or 11025 Hz.

# paths./2/vod/channels/{channel}/media.get.description
Retrieves a paginated list of non-discarded media associated with the provided channel.

# paths./2/vod/channels/{channel}/media.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/media/status.get.description
Get counters for each media status filtered by the requested period (defaults to `-7d`).

# paths./2/vod/channels/{channel}/media/status.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/media/{media}.put.description
Updates details of a specified media based on the provided parameters.

# paths./2/vod/media/{media}.put.requestBody.content.application/json.schema.properties.description.description
A brief {name} description (only for internal use)

# paths./2/vod/media/{media}.put.requestBody.content.application/json.schema.properties.password.description
password restricting the media access in the player

# paths./2/vod/media/{media}.put.requestBody.content.application/json.schema.properties.published.description
Defines whether the {name} has been published.
If the media is not published, it cannot be shared.

# paths./2/vod/media/{media}.put.requestBody.content.application/json.schema.properties.validated.description
A custom flag to help the user to manager its videos.
Only for management purposes.

# paths./2/vod/media/{media}/metadata.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/media/{media}/metadata.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Label</note>

# paths./2/vod/media/{media}/journal.get.description
Retrieves a paginated list of journal entries associated with the provided media.

# paths./2/vod/media/{media}/journal.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/journal.get.description
Retrieves a paginated list of journal entries associated with the provided channel.

# paths./2/vod/channels/{channel}/journal.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/media/{media}/thumbnails.get.description
Get a paginated list of thumbnails associated with the provided media, this list includes:
- image
- waveform image
- waveform JSON
- audio file
- frames matrix (10x10, simple)
- frames line
- frames matrix (very detailed)
- frames matrix (shot boundaries)
- high quality thumbnail

# paths./2/vod/media/{media}/thumbnails.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/thumbnails/{thumbnail}.get.description
Retrieves details of a specified thumbnail.

# paths./2/vod/channels/{channel}/shares.get.description
Retrieves a paginated list of shares associated with the provided channel based on the parameters.

# paths./2/vod/channels/{channel}/shares.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/shares.delete.description
Deletes shares specified in the request associated with the provided channel.

# paths./2/vod/channels/{channel}/shares.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Share</note>

# paths./2/vod/media/{media}/shares.get.description
Retrieves a paginated list of shares associated with the provided media based on the parameters.

# paths./2/vod/media/{media}/shares.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/media/{media}/shares.post.description
Generate a public accessible media playback link.

# paths./2/vod/media/{media}/shares.post.requestBody.content.application/json.schema.properties.player_settings.properties.auto_start.description
Whether the playback should start automatically

# paths./2/vod/media/{media}/shares.post.requestBody.content.application/json.schema.properties.player_settings.properties.force_media_ratio.description
Indicates whether media ratio is enforced for the Media

# paths./2/vod/media/{media}/shares.post.requestBody.content.application/json.schema.properties.player_settings.properties.preload_image.description
The preload image associated with the Media

# paths./2/vod/media/{media}/shares.post.requestBody.content.application/json.schema.properties.player_settings.properties.show_progression.description
Whether to show the show progression control

# paths./2/vod/media/{media}/shares.post.requestBody.content.application/json.schema.properties.timestamp.description
The timestamp of the starting frame to share the media from.

# paths./2/vod/media/{media}/shares.post.requestBody.content.application/json.schema.properties.validity.description
The {name} validity duration (in seconds)

# paths./2/vod/media/{media}/shares.delete.description
Deletes shares specified in the request associated with the provided media.

# paths./2/vod/media/{media}/shares.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Share</note>

# paths./2/vod/shares/{share}.put.description
Updates details of a specified share based on the parameters.

# paths./2/vod/shares/{share}.put.requestBody.content.application/json.schema.properties.player_settings.properties.auto_start.description
Whether the playback should start automatically

# paths./2/vod/shares/{share}.put.requestBody.content.application/json.schema.properties.player_settings.properties.force_media_ratio.description
Indicates whether media ratio is enforced for the Share

# paths./2/vod/shares/{share}.put.requestBody.content.application/json.schema.properties.player_settings.properties.preload_image.description
The preload image associated with the Share

# paths./2/vod/shares/{share}.put.requestBody.content.application/json.schema.properties.player_settings.properties.show_progression.description
Whether to show the show progression control

# paths./2/vod/shares/{share}.put.requestBody.content.application/json.schema.properties.timestamp.description
The timestamp of the starting frame to share the media from.

# paths./2/vod/shares/{share}.put.requestBody.content.application/json.schema.properties.validity.description
The {name} validity duration (in seconds)

# paths./2/vod/channels/{channel}/logos.get.description
Retrieves a paginated list of logos associated with the provided channel.

# paths./2/vod/channels/{channel}/logos.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/logos.post.description
Creates a new logo within the provided channel based on the provided parameters.

# paths./2/vod/channels/{channel}/logos.post.requestBody.content.application/json.schema.properties.mode.description
The {name} modeoverlay: The logo is added on top of the video by a player configuration embed: The logo is directly encoded in the video

# paths./2/vod/channels/{channel}/logos.post.requestBody.content.application/json.schema.properties.position.description
The anchor of the {name}top_left: Positioned at the top left corner top_middle: Positioned at the top middle top_right: Positioned at the top right corner center_left: Positioned at the center left center_middle: Positioned at the center middle center_right: Positioned at the center right bottom_left: Positioned at the bottom left corner bottom_middle: Positioned at the bottom middle bottom_right: Positioned at the bottom right corner

# paths./2/vod/channels/{channel}/logos.delete.description
Deletes logos specified in the request within the provided channel.

# paths./2/vod/channels/{channel}/logos.delete.parameters[].schema.description
The {name} modeoverlay: The logo is added on top of the video by a player configuration embed: The logo is directly encoded in the video

# paths./2/vod/channels/{channel}/logos.delete.parameters[].schema.description
The anchor of the {name}top_left: Positioned at the top left corner top_middle: Positioned at the top middle top_right: Positioned at the top right corner center_left: Positioned at the center left center_middle: Positioned at the center middle center_right: Positioned at the center right bottom_left: Positioned at the bottom left corner bottom_middle: Positioned at the bottom middle bottom_right: Positioned at the bottom right corner

# paths./2/vod/logos/{logo}.put.description
Updates details of a specified logo based on the provided parameters.

# paths./2/vod/logos/{logo}.put.requestBody.content.application/json.schema.properties.mode.description
The {name} modeoverlay: The logo is added on top of the video by a player configuration embed: The logo is directly encoded in the video

# paths./2/vod/logos/{logo}.put.requestBody.content.application/json.schema.properties.position.description
The anchor of the {name}top_left: Positioned at the top left corner top_middle: Positioned at the top middle top_right: Positioned at the top right corner center_left: Positioned at the center left center_middle: Positioned at the center middle center_right: Positioned at the center right bottom_left: Positioned at the bottom left corner bottom_middle: Positioned at the bottom middle bottom_right: Positioned at the bottom right corner

# paths./2/vod/channels/{channel}/labels.get.description
Get a paginated list of labels associated with the provided channel.

# paths./2/vod/channels/{channel}/labels.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/labels.post.description
Attach labels specified in the request associated with the provided channel.

# paths./2/vod/channels/{channel}/labels.delete.description
Deletes labels specified in the request associated with the provided channel.

# paths./2/vod/labels/{genericLabel}.put.description
Updates details of a specified label based on the given parameters.

# paths./2/vod/labels/{genericLabel}.put.requestBody.content.application/json.schema.properties.options.properties.color.description
Hexadecimal color code (with or without the leading #)

# paths./2/vod/channels/{channel}/metadata.get.description
Get a paginated list of metadata associated with the provided channel.

# paths./2/vod/channels/{channel}/metadata.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/metadata.post.description
Attach metadata specified in the request associated with the provided channel.

# paths./2/vod/channels/{channel}/metadata.delete.description
Deletes metadata specified in the request associated with the provided channel.

# paths./2/vod/channels/{channel}/ftpusers.get.description
Retrieves a paginated list of FTP users associated with the provided channel.

# paths./2/vod/channels/{channel}/ftpusers.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/channels/{channel}/ftpusers.post.description
Creates a new FTP user associated with the provided channel based on the parameters.

# paths./2/vod/channels/{channel}/ftpusers.post.requestBody.content.application/json.schema.properties.active.description
Determine whether the {name} should be active.

# paths./2/vod/channels/{channel}/ftpusers.post.requestBody.content.application/json.schema.properties.description.example
With great power comes great responsibility

# paths./2/vod/channels/{channel}/ftpusers.post.requestBody.content.application/json.schema.properties.msg_quit.description
The message displayed when the users logs out of the ftp client.

# paths./2/vod/ftpusers/{user}.get.description
Retrieves details of a specified FTP user.

# paths./2/vod/ftpusers/{user}.put.description
Updates details of a specified FTP user based on the parameters.

# paths./2/vod/ftpusers/{user}.put.requestBody.content.application/json.schema.properties.active.description
Determine whether the {name} should be active.

# paths./2/vod/ftpusers/{user}.put.requestBody.content.application/json.schema.properties.description.example
With great power comes great responsibility

# paths./2/vod/ftpusers/{user}.put.requestBody.content.application/json.schema.properties.msg_quit.description
The message displayed when the users logs out of the ftp client.

# paths./2/vod/ftpusers/{user}.delete.description
Deletes the specified FTP user associated with the provided channel.

# paths./2/vod/statistics/{channel}/clusters.get.description
Get the number of viewers per cluster for the provided channel.
A cluster is a grouping of viewers based on their geographical location.
A cluster is identified by its geohash, latitude and longitude.

# paths./2/vod/statistics/{channel}/clusters.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{channel}/clusters.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{channel}/clusters.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{channel}/media/top.get.description
Get a list of media for the requested period, sorted by viewers count.

# paths./2/vod/statistics/{channel}/media/top.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{channel}/media/top.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{channel}/media/top.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{channel}/media/top.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/statistics/{channel}/media/unique_viewers.get.description
Get the number of unique viewers (IP addresses) for the provided media list.

# paths./2/vod/statistics/{channel}/media/unique_viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{channel}/media/unique_viewers.get.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Media</note>

# paths./2/vod/statistics/{channel}/media/unique_viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{channel}/media/unique_viewers.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{channel}/media/viewers.get.description
Get the number of viewers for the provided media list.

# paths./2/vod/statistics/{channel}/media/viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{channel}/media/viewers.get.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Media</note>

# paths./2/vod/statistics/{channel}/media/viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{channel}/media/viewers.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/consumption.get.description
Get the consumption for the provided subject,
subject may be either a channel or a media,
if anything else is provided, a 404 error will be raised.

# paths./2/vod/statistics/{subject}/consumption.get.parameters[].schema.description
Any valid byte unit, with or without precision specified (tries to format bytes in the most readable unit if nothing is specified):
YB: Yotta Byte ZB: Zetta Byte EB: Exa Byte PB: Peta Byte TB: Tera Byte GB: Giga Byte MB: Mega Byte kB: Kilo Byte B: Byte no: No formatting (raw number of bytes)A precision (digits after '.') may be added with the following notation:
6: 1.322123MB/6: 1.322123MB MB/6: 1.322123MB MB/000000: 1.322123MB GB/9: 0.001322123GB

# paths./2/vod/statistics/{subject}/consumption.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/consumption.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/consumption.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/view_time.get.description
Get the view time (in milliseconds) for the provided subject,
subject may be either a channel or a media,
if anything else is provided, a 404 error will be raised.

# paths./2/vod/statistics/{subject}/view_time.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/view_time.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/view_time.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/viewers.get.description
Get the number of viewers for the provided subject,
subject may be either a channel or a media,
if anything else is provided, a 404 error will be raised.

# paths./2/vod/statistics/{subject}/viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/viewers.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/unique_viewers.get.description
Get the number of unique viewers (IP addresses) for the provided subject,
subject may be either a channel or a media,
if anything else is provided, a 404 error will be raised.

# paths./2/vod/statistics/{subject}/unique_viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/unique_viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/unique_viewers.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/average_view_time.get.description
Get the average view time (in milliseconds) per unique user (IP addresses) for the provided subject,
subject may be either a channel or a media,
if anything else is provided, a 404 error will be raised.

# paths./2/vod/statistics/{subject}/average_view_time.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/average_view_time.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/average_view_time.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/histogram/encodings.get.description
Retrieve histogram with general statistics per time bucket,
along with breakdown per encoding.

# paths./2/vod/statistics/{subject}/histogram/encodings.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/histogram/encodings.get.parameters[].schema.description
hour: Interval of time lasting 60 minutes day: Interval of time lasting 24 hours week: Interval of time lasting 7 days month: Interval of time approximately lasting 30 days quarter: Interval of time lasting approximately 3 months year: Interval of time lasting 12 months

# paths./2/vod/statistics/{subject}/histogram/encodings.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/histogram/encodings.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/histogram/viewers.get.description
Get a histogram of viewers over time for the provided subject.
The data is divided into time buckets based on the requested interval.

# paths./2/vod/statistics/{subject}/histogram/viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/histogram/viewers.get.parameters[].schema.description
hour: Interval of time lasting 60 minutes day: Interval of time lasting 24 hours week: Interval of time lasting 7 days month: Interval of time approximately lasting 30 days quarter: Interval of time lasting approximately 3 months year: Interval of time lasting 12 months

# paths./2/vod/statistics/{subject}/histogram/viewers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/histogram/viewers.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/browsers.get.description
Get the number of viewers and consumed time (in milliseconds) per browser for the provided subject.

# paths./2/vod/statistics/{subject}/browsers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/browsers.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/browsers.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/countries.get.description
Retrieves the number of viewers and total share per country for the provided subject;
The share is based on all the countries for this subject, not just on the countries within the limit.
Therefore, the sum of the share for each country may not reach 1 (100%) if a limit is provided.

# paths./2/vod/statistics/{subject}/countries.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/countries.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/countries.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/operating_systems.get.description
Get the number of viewers and consumed time (in milliseconds) per operating system for the provided subject.

# paths./2/vod/statistics/{subject}/operating_systems.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/operating_systems.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/operating_systems.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/playbacks.get.description
Get the number of viewers and consumed time (in milliseconds) per playback type for the provided subject.

# paths./2/vod/statistics/{subject}/playbacks.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/playbacks.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/playbacks.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/players.get.description
Get the number of viewers and consumed time (in milliseconds) per player for the provided subject.

# paths./2/vod/statistics/{subject}/players.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/players.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/players.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/origins.get.description
Get the number of viewers and consumed time (in milliseconds) per origin for the provided subject.

# paths./2/vod/statistics/{subject}/origins.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/origins.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/origins.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/sources.get.description
Get the number of viewers and consumed time (in milliseconds) per source for the provided subject.

# paths./2/vod/statistics/{subject}/sources.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/sources.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/sources.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/viewers_per_encoding.get.description
Get the number of viewers per encoding for the provided subject.

# paths./2/vod/statistics/{subject}/viewers_per_encoding.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/viewers_per_encoding.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/viewers_per_encoding.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/consumed_time_per_encoding.get.description
Get the viewing time (in milliseconds) per encoding for the provided subject.

# paths./2/vod/statistics/{subject}/consumed_time_per_encoding.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/consumed_time_per_encoding.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/consumed_time_per_encoding.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/devices.get.description
Get the number of viewers and consumed time (in milliseconds) per device type for the provided subject.

# paths./2/vod/statistics/{subject}/devices.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/devices.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/devices.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{subject}/technologies.get.description
Get the number of viewers and consumed time (in milliseconds) for all technologies for the provided subject.
Statistics are grouped by browsers, operating systems, playbacks, players, devices and sources.

# paths./2/vod/statistics/{subject}/technologies.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/technologies.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{subject}/technologies.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{media}/retention.get.description
Get retention per percent for the provided media,
if anything else is provided, a 404 error will be raised.
The returned collection contains a list of percents [0-99],
each percent contains a hit count and a normalized value.

# paths./2/vod/statistics/{media}/retention.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{media}/retention.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{media}/retention.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{media}/rank.get.description
Computes the rank of the provided media based on its view count relative to other media within the same channel.

# paths./2/vod/statistics/{media}/rank.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{media}/rank.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{media}/rank.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/statistics/{media}/benchmark.get.description
Retrieves statistics and comparisons between the media and the other media of the same channel.

# paths./2/vod/statistics/{media}/benchmark.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{media}/benchmark.get.parameters[].schema.description
Date: any accepted PHP date format Timestamp: a Timestamp Time interval: a positive or negative interval with pattern:
/\+|\-\d+[YyMdhims]/

symbol | description
Y|y | Year
M | Month
d | Day
h | Hour
i|m | Minute
s | Second

# paths./2/vod/statistics/{media}/benchmark.get.parameters[].schema.description
Limit the response size to the top N results.

# paths./2/vod/res/thumbnails/{thumbnail}.{format}.get.description
Render the thumbnail inline directly in the user browser.
If the thumbnail is corrupted, a 404 error is returned.

# paths./2/vod/res/playlists/{playlist}.{format}.get.description
Render the playlist image inline directly in the user browser.
If the playlist has no image, a 404 error is returned.

# paths./2/vod/res/shares/{share}.{image}.{format}.get.description
Render the share image inline directly in the user browser.
If the share has no image, a 404 error is returned.

# paths./2/vod/res/shares/{share}.{image}.{format}.get.parameters[].description
Use one of the following valueslogo: Image used as a logo or branding element preload: Image intended for preloading or prefetching interrupt: Image displayed during interruptions or loading delays geoip: Image customized based on geographical location restrict: Image with restrictions or access control settings

# paths./2/vod/res/players/{player}.{image}.{format}.get.description
Render the player image inline directly in the user browser.
If the player has no image, a 404 error is returned.

# paths./2/vod/res/players/{player}.{image}.{format}.get.parameters[].description
Use one of the following valueslogo: Image used as a logo or branding element preload: Image intended for preloading or prefetching interrupt: Image displayed during interruptions or loading delays geoip: Image customized based on geographical location restrict: Image with restrictions or access control settings

# paths./2/vod/res/logos/{logo}.{format}.get.description
Render the logo image inline directly in the user browser.
If the logo is invalid, a 404 error is returned.

# paths./2/vod/res/media/{media}/chapters.{format}.get.description
Render the published media chapters directly in the user browser.
If no published chapters are available a 404 error is returned.

# paths./2/vod/res/media/{media}/chapters.{format}.get.parameters[].description
Use one of the following valuesjson: JavaScript Object Notation data format xml: EXtensible Markup Language data format yaml: YAML Ain't Markup Language data format vtt: WebVTT (Web Video Text Tracks) subtitle format

# paths./2/vod/res/chapters/{chapter}.{format}.get.description
Render the chapter image inline directly in the user browser.
If the chapter has no image, a 404 error is returned.

# paths./2/vod/res/subtitles/{subtitle}.{format}.get.description
Render the subtitle in the requested format.

# paths./2/vod/res/subtitles/{subtitle}.{format}.get.parameters[].description
Use one of the following valuessrt: Simple subtitle format vtt: WebVTT subtitle format sub: Generic subtitle format stl: EBU STL subtitle format sbv: YouTube subtitle format json: Raw json format txt: Plain text format dxfp: Standard for XML captions and subtitles based on the TTML (Timed Text Markup Language) format ttml: Standard for XML captions developed by the World Wide Web Consortium (W3C)

# paths./2/vod/res/suggestions/{target}.get.description
Retrieve a list of media suggestions based on the current media.

# paths./2/vod/channels/{channel}/services.post.description
Sync linked services to a given channel.

# paths./2/vod/channels/{channel}/browse/restore.post.description
Restores the specified file associated with the provided channel based on the provided parameters.

# paths./2/vod/channels/{channel}/browse/restore.post.requestBody.content.application/json.schema.properties.files.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Bvf</note>

# paths./2/vod/channels/{channel}/browse/move.post.description
Moves the specified file to a new location within the channel based on the provided parameters.

# paths./2/vod/channels/{channel}/browse/move.post.requestBody.content.application/json.schema.properties.files.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Bvf</note>

# paths./2/vod/folders/{folder}/encodings.put.description
Attaches encodings to a specified folder based on the provided parameters.

# paths./2/vod/folders/{folder}/encodings.put.requestBody.content.application/json.schema.properties.encodings.description
The encodings associated with the Folder

# paths./2/vod/folders/{folder}/encodings.post.description
Synchronizes encodings for a specified folder based on the provided parameters.

# paths./2/vod/folders/{folder}/encodings.post.requestBody.content.application/json.schema.properties.encodings.description
The encodings associated with the Folder

# paths./2/vod/folders/{folder}/encodings.delete.description
Detaches encodings from a specified folder based on the provided parameters.

# paths./2/vod/folders/{folder}/encodings.delete.parameters[].schema.description
The encodings associated with the Folder

# paths./2/vod/mixtapes/{mixtape}/duplicate.post.description
Creates a copy of the specified mixtape with the same configuration
and direct media attachments. The new mixtape name can be provided
or will default to "{original_name} (Copy)".

# paths./2/vod/mixtapes/{mixtape}/duplicate.post.requestBody.content.application/json.schema.properties.name.description
 Optional custom name for the duplicated mixtape

# paths./2/vod/mixtapes/{mixtape}/media/{media}/move.post.summary
Move a manually attached media in mixtape.

# paths./2/vod/mixtapes/{mixtape}/media/{media}/move.post.description
Move a given media to given position in manually attached media.

# paths./2/vod/mixtapes/{mixtape}/media/{media}/move.post.requestBody.content.application/json.schema.properties.position.description
 the position you want to place the media at

# paths./2/vod/mixtapes/{mixtape}/media/{media}/move.post.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/vod/media/{media}/suggest.post.description
Attach a list of media that will be suggested during
playback once the current media is over.

# paths./2/vod/media/{media}/suggest.post.requestBody.content.application/json.schema.properties.media.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Media</note>

# paths./2/vod/shares/{share}/token.post.description
Creates a new token associated with the provided share based on the provided parameters..

# paths./2/vod/shares/{share}/token.post.parameters[].schema.description
Extra header to pass if `ip_address` should be used, if this header isn't passed, the `ip_address` field will be ignored.

# paths./2/vod/shares/{share}/token.post.requestBody.content.application/json.schema.properties.allowed_domains.items.description
a valid domain name or URL that has either a valid A or an AAAA dns record

# paths./2/vod/shares/{share}/token.post.requestBody.content.application/json.schema.properties.restricted_domains.items.description
a valid domain name or URL that has either a valid A or an AAAA dns record

# paths./2/vod/shares/{share}/token.post.requestBody.content.application/json.schema.properties.restricted_domains.description
List of restricted domain names for the Token

# paths./2/vod/shares/{share}/token.post.requestBody.content.application/json.schema.properties.strategy.description
the playback strategy to enforce protection forhls: Apple HTTP Live Streaming dash: Dynamic Adaptive Streaming over HTTP single: Single bitrate best: Playback strategy selecting the best available quality dynamically

# paths./2/vod/shares/{share}/token.post.requestBody.content.application/json.schema.properties.window.description
The Token validity duration (in seconds)

# paths./2/vod/ftp/login.post.description
Attempts to authenticate the user using the provided credentials.

# paths./2/vod/ftp/login.post.requestBody.content.application/json.schema.properties.username.pattern
(?:(?<prefix>\w{5})(?=-\w))?-?(?<username>.*)

# paths./2/vod/ftp/on/connect.post.description
Handles the FTP server connection event.

# paths./2/vod/ftp/on/disconnect.post.description
Handles the FTP server disconnection event.

# paths./2/vod/ftp/on/login-failed.post.description
Handles the FTP server login failure event.

# paths./2/vod/folders/{folder}/logo.put.description
Attaches a logo to a specified folder based on the provided parameters.

# paths./2/vod/folders/{folder}/logo.delete.description
Detaches a logo from a specified folder.

# paths./2/vod/folders/{folder}/labels.put.description
Attaches labels to a specified folder based on the provided parameters.

# paths./2/vod/folders/{folder}/labels.put.requestBody.content.application/json.schema.properties.labels.items.properties.options.properties.color.description
Hexadecimal color code (with or without the leading #)

# paths./2/vod/folders/{folder}/labels.delete.description
Detaches labels from a specified folder based on the provided parameters.

# paths./2/vod/folders/{folder}/labels.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Label</note>

# paths./2/vod/media/{media}/labels.put.description
Attaches labels to a specified media based on the provided parameters.

# paths./2/vod/media/{media}/labels.put.requestBody.content.application/json.schema.properties.labels.items.properties.options.properties.color.description
Hexadecimal color code (with or without the leading #)

# paths./2/vod/media/{media}/labels.delete.description
Detaches labels from a specified media based on the provided parameters.

# paths./2/vod/media/{media}/labels.delete.parameters[].schema.description
A list of items, (either comma separated or as an array) (no duplicates) with the following rules: <note><bold>1</bold>: Identifier of an existing Label</note>

# paths./2/vod/metadata/{metadata}.put.description
Updates details of a specified metadata based on the given parameters.

# paths./2/vod/metadata/{metadata}.put.requestBody.content.application/json.schema.properties.options.properties.color.description
Hexadecimal color code (with or without the leading #)

# paths./2/vod/folders/{folder}/lock.put.description
A locked folder cannot be updated or configured in any way.
This action can only be reverted with the dedicated unlock route.

# paths./2/vod/folders/{folder}/unlock.put.description
A locked folder cannot be updated, unlock it first
in order to being able to configure it again.

# paths./1/url-shortener.get.description
This endpoint allows you to fetch your short urls.

# paths./1/url-shortener.post.description
This endpoint allows you to create a short url.

# paths./1/url-shortener.post.x-codeSamples[].source
curl -X POST
-H Authorization: Bearer YOUR-TOKEN-HERE
-H "Content-Type: application/json"
-d '{
    "url": "https://www.infomaniak.com",
    "expiration_date": "1633435272"
}'
https://api.infomaniak.com/1/url-shortener

# paths./2/url-shortener.get.description
This endpoint allows you to fetch your short urls.

# paths./2/url-shortener.post.description
This endpoint allows you to create a short url.

# paths./2/url-shortener.post.x-codeSamples[].source
curl -X POST
-H Authorization: Bearer YOUR-TOKEN-HERE
-H "Content-Type: application/json"
-d '{
    "url": "https://www.infomaniak.com",
    "expiration_date": "1633435272"
}'
https://api.infomaniak.com/1/url-shortener

# paths./1/url-shortener/{short_url_code}.put.description
This endpoint allows you to update a short url expiration date.

# paths./1/url-shortener/{short_url_code}.put.x-codeSamples[].source
curl -X PUT
-H Authorization: Bearer YOUR-TOKEN-HERE
-H "Content-Type: application/json"
-d '{
    "expiration_date": "1633435272"
}'
https://api.infomaniak.com/1/url-shortener/002Ufgv

# paths./1/url-shortener/quota.get.description
This endpoint allows you to fetch your short url quota.

# paths./2/url-shortener/quota.get.description
This endpoint allows you to fetch your short url quota.

# paths./1/vod/channel.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/user-activity-log.put.summary
Revert channel models to a previous date

# paths./1/vod/channel/{channel}/user-activity-log.put.description
Revert channel models to a previous date

# paths./1/vod/channel/{channel}/user-activity-log.put.requestBody.content.application/json.schema.properties.auto_empty_trash_unit.description
This field must be present and not empty only if any of the following fields are present:`auto_empty_trash`

# paths./1/vod/channel/{channel}/disk-usage.get.description
Returns the disk usage (in bytes) for the given channel.

# paths./1/vod/channel/{channel}/browse.get.summary
Lists all children of the channel's root folder.

# paths./1/vod/channel/{channel}/browse.delete.summary
Moves one or many medias/folders to trash.

# paths./1/vod/channel/{channel}/browse/move.post.summary
Moves one or many medias/folders to a given folder.

# paths./1/vod/channel/{channel}/browse/copy.post.summary
Duplicates one or many medias/folders to a given folder.

# paths./1/vod/channel/{channel}/browse/export.post.summary
Exports one or many medias to an external platform.

# paths./1/vod/channel/{channel}/browse/trash.delete.summary
Deletes one or many medias/folders from trash, permanently.

# paths./1/vod/channel/{channel}/browse/trash/restore.delete.summary
Restores one or many medias/folders from trash to their original location.

# paths./1/vod/channel/{channel}/browse/trash/{file}.delete.summary
Deletes a media/folder from trash, permanently.

# paths./1/vod/channel/{channel}/browse/trash/{file}/restore.post.summary
Restores a media/folder from trash to its original location.

# paths./1/vod/channel/{channel}/browse/tree.get.summary
Returns the tree of the folder with all its children, recursively.

# paths./1/vod/channel/{channel}/browse/breadcrumb.get.summary
Returns the breadcrumb of the media/folder up to root ancestor.

# paths./1/vod/channel/{channel}/browse/{file}/copy.post.summary
Duplicates a media/folder to a given folder.

# paths./1/vod/channel/{channel}/browse/{file}/export.post.summary
Exports a media to an external platform.

# paths./1/vod/channel/{channel}/browse/{file}/breadcrumb.get.summary
Returns the breadcrumb of the media/folder up to root ancestor.

# paths./1/vod/channel/{channel}/browse/{file}/tree.get.summary
Returns the tree of the folder with all its children, recursively.

# paths./1/vod/channel/{channel}/callback/log.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/callback.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/callback.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/callback.post.requestBody.content.application/json.schema.properties.basic_username.description
This field must be present and not empty if the `auth` field is equal to any of the following:`basic`

# paths./1/vod/channel/{channel}/callback.post.requestBody.content.application/json.schema.properties.basic_password.description
This field must be present and not empty if the `auth` field is equal to any of the following:`basic`

# paths./1/vod/channel/{channel}/callback.post.requestBody.content.application/json.schema.properties.bearer_token.description
This field must be present and not empty if the `auth` field is equal to any of the following:`bearer`

# paths./1/vod/channel/{channel}/callback/{callback}.put.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/callback/{callback}.put.requestBody.content.application/json.schema.properties.basic_username.description
This field must be present and not empty if the `auth` field is equal to any of the following:`basic`

# paths./1/vod/channel/{channel}/callback/{callback}.put.requestBody.content.application/json.schema.properties.basic_password.description
This field must be present and not empty if the `auth` field is equal to any of the following:`basic`

# paths./1/vod/channel/{channel}/callback/{callback}.put.requestBody.content.application/json.schema.properties.bearer_token.description
This field must be present and not empty if the `auth` field is equal to any of the following:`bearer`

# paths./1/vod/channel/{channel}/callback/{callback}.patch.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/callback/{callback}.patch.requestBody.content.application/json.schema.properties.basic_username.description
This field must be present and not empty if the `auth` field is equal to any of the following:`basic`

# paths./1/vod/channel/{channel}/callback/{callback}.patch.requestBody.content.application/json.schema.properties.basic_password.description
This field must be present and not empty if the `auth` field is equal to any of the following:`basic`

# paths./1/vod/channel/{channel}/callback/{callback}.patch.requestBody.content.application/json.schema.properties.bearer_token.description
This field must be present and not empty if the `auth` field is equal to any of the following:`bearer`

# paths./1/vod/channel/{channel}/encoding.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/logo.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/logo.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/logo.post.requestBody.content.application/json.schema.properties.logo.description
The file under validation must have a MIME type corresponding to one of the following extensions:`image`, `gif`, `png`, `webp`, `jpg`, `jpe`, `jpeg`, `pjpeg`

# paths./1/vod/channel/{channel}/logo/{logo}.put.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/logo/{logo}.patch.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/folder.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/folder.post.summary
Creates a new folder in the channel's root folder.

# paths./1/vod/channel/{channel}/folder.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/folder.post.requestBody.content.application/json.schema.properties.parent_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/folder.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/folder/{folder}.put.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}.put.requestBody.content.application/json.schema.properties.parent_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}.put.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/folder/{folder}.post.summary
Creates a new folder in the parent folder.

# paths./1/vod/channel/{channel}/folder/{folder}.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}.post.requestBody.content.application/json.schema.properties.parent_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/folder/{folder}.delete.summary
Deletes a folder with all its children, recursively.

# paths./1/vod/channel/{channel}/folder/{folder}.patch.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}.patch.requestBody.content.application/json.schema.properties.parent_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}.patch.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/folder/{folder}/playlist.get.summary
Lists all playlists having a given folder attached.

# paths./1/vod/channel/{channel}/folder/{folder}/encoding.post.summary
Adds one or many given encodings to a folder.

# paths./1/vod/channel/{channel}/folder/{folder}/encoding.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}/encoding.post.requestBody.content.application/json.schema.properties.parent_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}/encoding.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/folder/{folder}/encoding.delete.description
Removes one or many given encodings from a folder.->remove logo from folder

# paths./1/vod/channel/{channel}/folder/{folder}/encoding/{encoding}.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}/encoding/{encoding}.post.requestBody.content.application/json.schema.properties.parent_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}/encoding/{encoding}.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/folder/{folder}/logo/{logo}.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}/logo/{logo}.post.requestBody.content.application/json.schema.properties.parent_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/folder/{folder}/logo/{logo}.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/ftp/user.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/ftp/user.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/ftp/user/{ftpUser}.put.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/ftp/user/{ftpUser}.patch.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/media.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.folder_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.category_id.description
This field must exist on the `categories` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `medias` database in the `name` column.

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.streams.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.duration.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.http_ip.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.http_user_agent.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.cli_user.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}.put.requestBody.content.application/json.schema.properties.cli_hostname.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.folder_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.category_id.description
This field must exist on the `categories` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `medias` database in the `name` column.

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.streams.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.duration.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.http_ip.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.http_user_agent.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.cli_user.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}.patch.requestBody.content.application/json.schema.properties.cli_hostname.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.summary
Get new more precise waveform ( for medias older than 2024, async job )

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.folder_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.category_id.description
This field must exist on the `categories` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `medias` database in the `name` column.

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.streams.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.duration.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.http_ip.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.http_user_agent.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.cli_user.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}/waveform.post.requestBody.content.application/json.schema.properties.cli_hostname.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.summary
Get new thumbstrip thumbnail ( for medias older than 2024, async job )

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.folder_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.category_id.description
This field must exist on the `categories` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `medias` database in the `name` column.

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.streams.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.duration.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.http_ip.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.http_user_agent.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.cli_user.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}/thumbstrip.post.requestBody.content.application/json.schema.properties.cli_hostname.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}/playlist.get.summary
Lists all playlists having a given media attached.

# paths./1/vod/channel/{channel}/media/{media}/annotation.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/media/{media}/annotation.post.summary
Creates a new annotation to a given media.

# paths./1/vod/channel/{channel}/media/{media}/annotation.post.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/annotation/{annotation}.put.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/annotation/{annotation}.patch.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/chapter.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/media/{media}/chapter.post.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/chapter.post.requestBody.content.application/json.schema.properties.timestamp.description
This field must not exist on the `chapters` database in the `NULL` column.

# paths./1/vod/channel/{channel}/media/{media}/chapter.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/media/{media}/chapter/{chapter}.put.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/chapter/{chapter}.put.requestBody.content.application/json.schema.properties.timestamp.description
This field must not exist on the `chapters` database in the `NULL` column.

# paths./1/vod/channel/{channel}/media/{media}/chapter/{chapter}.put.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/media/{media}/chapter/{chapter}.patch.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/chapter/{chapter}.patch.requestBody.content.application/json.schema.properties.timestamp.description
This field must not exist on the `chapters` database in the `NULL` column.

# paths./1/vod/channel/{channel}/media/{media}/chapter/{chapter}.patch.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/media/{media}/subtitle.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/media/{media}/subtitle.post.description
( async action ) Generate subtitle from media

# paths./1/vod/channel/{channel}/media/{media}/subtitle.post.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle.post.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{language}.post.description
Creates a new subtitle to a given media.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{language}.post.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{language}.post.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{language}/impor.post.description
Creates a new subtitle to a given media, from a provided file.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{language}/impor.post.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{language}/impor.post.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{language}/impor.post.requestBody.content.application/json.schema.properties.file.description
The file under validation must have a MIME type corresponding to one of the following extensions:`application`, `x-subrip`, `text`, `plain`, `vtt`, `x-subviewer`

# paths./1/vod/channel/{channel}/media/{media}/subtitle/summarize.get.description
( async action ) Get Summary from a media by extracting first its subtitles, then setting it as its media description

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}/defau.put.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}/defau.put.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}.put.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}.put.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}.patch.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}.patch.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}/trans.post.description
( async action ) Translate a subtitle into other languages

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}/trans.post.requestBody.content.application/json.schema.properties.languages.items.description
languages in en,fr,it,de you want to translate the subtitle into 

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}/trans.post.requestBody.content.application/json.schema.properties.languages.description
languages in en,fr,it,de,es you want to translate the subtitle into 

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}/summa.get.description
( async action ) Get Summary from an existing subtitle, then setting it as its media description

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}/summa.post.description
Get Summary from an existing subtitle with custom parameters

# paths./1/vod/channel/{channel}/media/{media}/subtitle/{subtitle}/summa.post.requestBody.content.application/json.schema.properties.generate_title.description
Do we want a description to be generated?

# paths./1/vod/channel/{channel}/media/{media}/thumbnail.post.summary
Replaces the thumbnail & poster for a given media

# paths./1/vod/channel/{channel}/media/{media}/thumbnail.post.description
Replaces the thumbnail & poster for a given media  with the file provided in the request as multipart/form-data.

# paths./1/vod/channel/{channel}/media/{media}/thumbnail.post.requestBody.content.application/json.schema.properties.media_id.description
This field must exist on the `medias` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/thumbnail.post.requestBody.content.application/json.schema.properties.width.description
This field must be present and not empty only if any of the following fields are present:`height`

# paths./1/vod/channel/{channel}/media/{media}/thumbnail.post.requestBody.content.application/json.schema.properties.height.description
This field must be present and not empty only if any of the following fields are present:`width`

# paths./1/vod/channel/{channel}/media/{media}/thumbnail.post.requestBody.content.application/json.schema.properties.file.description
The file under validation must have a MIME type corresponding to one of the following extensions:`image`, `gif`, `png`, `webp`, `jpg`, `jpe`, `jpeg`, `pjpeg`

# paths./1/vod/channel/{channel}/media/{media}/cut.post.description
Cut a media with {"from":2,"duration":20} in seconds

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.folder_id.description
This field must exist on the `folders` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.category_id.description
This field must exist on the `categories` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.language_id.description
This field must exist on the `languages` database in the `id` column.

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `medias` database in the `name` column.

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.streams.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.duration.description
This field must be present and not empty only if any of the following fields are present:`collected_at`

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.http_ip.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.http_user_agent.description
This field must be present and not empty if the `client` field is equal to any of the following:`http`

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.cli_user.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/media/{media}/logo/{logo}.post.requestBody.content.application/json.schema.properties.cli_hostname.description
This field must be present and not empty if the `client` field is equal to any of the following:`cli`

# paths./1/vod/channel/{channel}/player.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.default_speed.description
This field must be present and not empty if the `show_speed` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.related_type.description
This field must be present and not empty if the `play_related` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.logo_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`logo_image`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.logo_anchor.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.logo_margin_vertical.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.logo_margin_horizontal.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.logo_percentage.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.media_thumbnail_anchor.description
This field must be present and not empty if the `show_media_thumbnail` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.facebook_back_link.description
This field must be present and not empty if the `enable_facebook` field is equal to any of the following:`1`
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.twitter_via.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.twitter_back_link.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.twitter_related.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.interrupt_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`interrupt_image`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.geoip_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`geoip_image`

# paths./1/vod/channel/{channel}/player.post.requestBody.content.application/json.schema.properties.restrict_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`restrict_image`

# paths./1/vod/channel/{channel}/player/{player}/ad.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/player/{player}/ad.post.requestBody.content.application/json.schema.properties.player_id.description
This field must exist on the `players` database in the `id` column.

# paths./1/vod/channel/{channel}/player/{player}/ad.post.requestBody.content.application/json.schema.properties.url.description
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}/ad.post.requestBody.content.application/json.schema.properties.href.description
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}/ad.post.requestBody.content.application/json.schema.properties.offset.description
This field must be present and not empty if the `type` field is equal to any of the following:`mid_roll`

# paths./1/vod/channel/{channel}/player/{player}/ad/{ad}.put.requestBody.content.application/json.schema.properties.player_id.description
This field must exist on the `players` database in the `id` column.

# paths./1/vod/channel/{channel}/player/{player}/ad/{ad}.put.requestBody.content.application/json.schema.properties.url.description
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}/ad/{ad}.put.requestBody.content.application/json.schema.properties.href.description
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}/ad/{ad}.put.requestBody.content.application/json.schema.properties.offset.description
This field must be present and not empty if the `type` field is equal to any of the following:`mid_roll`

# paths./1/vod/channel/{channel}/player/{player}/ad/{ad}.patch.requestBody.content.application/json.schema.properties.player_id.description
This field must exist on the `players` database in the `id` column.

# paths./1/vod/channel/{channel}/player/{player}/ad/{ad}.patch.requestBody.content.application/json.schema.properties.url.description
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}/ad/{ad}.patch.requestBody.content.application/json.schema.properties.href.description
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}/ad/{ad}.patch.requestBody.content.application/json.schema.properties.offset.description
This field must be present and not empty if the `type` field is equal to any of the following:`mid_roll`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.default_speed.description
This field must be present and not empty if the `show_speed` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.related_type.description
This field must be present and not empty if the `play_related` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.logo_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`logo_image`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.logo_anchor.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.logo_margin_vertical.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.logo_margin_horizontal.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.logo_percentage.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.media_thumbnail_anchor.description
This field must be present and not empty if the `show_media_thumbnail` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.facebook_back_link.description
This field must be present and not empty if the `enable_facebook` field is equal to any of the following:`1`
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.twitter_via.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.twitter_back_link.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.twitter_related.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.interrupt_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`interrupt_image`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.geoip_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`geoip_image`

# paths./1/vod/channel/{channel}/player/{player}.put.requestBody.content.application/json.schema.properties.restrict_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`restrict_image`

# paths./1/vod/channel/{channel}/player/{player}.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/vod/channel/{channel}/player/{player}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/vod/channel/{channel}/player/{player}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/vod/channel/{channel}/player/{player}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/vod/channel/{channel}/player/{player}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/vod/channel/{channel}/player/{player}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.default_speed.description
This field must be present and not empty if the `show_speed` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.related_type.description
This field must be present and not empty if the `play_related` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.logo_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`logo_image`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.logo_anchor.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.logo_margin_vertical.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.logo_margin_horizontal.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.logo_percentage.description
This field must be present and not empty if the `logo_image` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.media_thumbnail_anchor.description
This field must be present and not empty if the `show_media_thumbnail` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.facebook_back_link.description
This field must be present and not empty if the `enable_facebook` field is equal to any of the following:`1`
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.twitter_via.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.twitter_back_link.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`
This domain name must have a valid A or AAAA record.

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.twitter_related.description
This field must be present and not empty if the `enable_twitter` field is equal to any of the following:`1`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.interrupt_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`interrupt_image`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.geoip_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`geoip_image`

# paths./1/vod/channel/{channel}/player/{player}.patch.requestBody.content.application/json.schema.properties.restrict_image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`restrict_image`

# paths./1/vod/channel/{channel}/player/{player}.patch.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/vod/channel/{channel}/player/{player}.patch.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/vod/channel/{channel}/player/{player}.patch.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/vod/channel/{channel}/playlist/attach.post.summary
Adds one or many given medias/folders to one or many playlists.

# paths./1/vod/channel/{channel}/playlist/detach.delete.summary
Removes one or many given medias/folders from one or many playlists.

# paths./1/vod/channel/{channel}/playlist.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/playlist.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/playlist.post.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `playlists` database in the `name` column.

# paths./1/vod/channel/{channel}/playlist.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/playlist.post.requestBody.content.application/json.schema.properties.live_reference_time.description
This field must be present and not empty if the `mode` field is equal to any of the following:`4`
This field must match the `"H:i:s"` format.

# paths./1/vod/channel/{channel}/playlist/{playlist}.put.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}.put.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `playlists` database in the `name` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}.put.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/playlist/{playlist}.put.requestBody.content.application/json.schema.properties.live_reference_time.description
This field must be present and not empty if the `mode` field is equal to any of the following:`4`
This field must match the `"H:i:s"` format.

# paths./1/vod/channel/{channel}/playlist/{playlist}.patch.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}.patch.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `playlists` database in the `name` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}.patch.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/playlist/{playlist}.patch.requestBody.content.application/json.schema.properties.live_reference_time.description
This field must be present and not empty if the `mode` field is equal to any of the following:`4`
This field must match the `"H:i:s"` format.

# paths./1/vod/channel/{channel}/playlist/{playlist}/attach.post.summary
Adds one or many given medias/folders to a playlist.

# paths./1/vod/channel/{channel}/playlist/{playlist}/detach.delete.summary
Removes one or many given medias/folders from a playlist.

# paths./1/vod/channel/{channel}/playlist/{playlist}/browse/{folder?}.get.summary
Lists all children of a given folder, with attached to playlist flag.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/up.post.summary
Moves one or many given medias one position up.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/up.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/up.post.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `playlists` database in the `name` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/up.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/up.post.requestBody.content.application/json.schema.properties.live_reference_time.description
This field must be present and not empty if the `mode` field is equal to any of the following:`4`
This field must match the `"H:i:s"` format.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/down.post.summary
Moves one or many given medias one position down.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/down.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/down.post.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `playlists` database in the `name` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/down.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/down.post.requestBody.content.application/json.schema.properties.live_reference_time.description
This field must be present and not empty if the `mode` field is equal to any of the following:`4`
This field must match the `"H:i:s"` format.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/after.post.summary
Moves one or many given medias after a given media.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/after.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/after.post.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `playlists` database in the `name` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/after.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/after.post.requestBody.content.application/json.schema.properties.live_reference_time.description
This field must be present and not empty if the `mode` field is equal to any of the following:`4`
This field must match the `"H:i:s"` format.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/before.post.summary
Moves one or many given medias before a given media.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/before.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/before.post.requestBody.content.application/json.schema.properties.name.description
This field must not exist on the `playlists` database in the `name` column.

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/before.post.requestBody.content.application/json.schema.properties.image_mimetype.description
This field must be present and not empty only if any of the following fields are present:`image`

# paths./1/vod/channel/{channel}/playlist/{playlist}/media/move/before.post.requestBody.content.application/json.schema.properties.live_reference_time.description
This field must be present and not empty if the `mode` field is equal to any of the following:`4`
This field must match the `"H:i:s"` format.

# paths./1/vod/channel/{channel}/share.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/share.post.description
Creates a share media or playlist, returns a share having id in order to build this url : https://player.vod2.infomaniak.com/res/embed/{{ ID }}.html

# paths./1/vod/channel/{channel}/share.post.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/share.post.requestBody.content.application/json.schema.properties.player_id.description
This field must exist on the `players` database in the `id` column.

# paths./1/vod/channel/{channel}/share.post.requestBody.content.application/json.schema.properties.encoding_id.description
This field must be present and not empty if the `target_type` field is equal to any of the following:`vod_media`
This field must exist on the `encodings` database in the `id` column.

# paths./1/vod/channel/{channel}/share/{share}.put.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/share/{share}.put.requestBody.content.application/json.schema.properties.player_id.description
This field must exist on the `players` database in the `id` column.

# paths./1/vod/channel/{channel}/share/{share}.put.requestBody.content.application/json.schema.properties.encoding_id.description
This field must be present and not empty if the `target_type` field is equal to any of the following:`vod_media`
This field must exist on the `encodings` database in the `id` column.

# paths./1/vod/channel/{channel}/share/{share}.patch.requestBody.content.application/json.schema.properties.channel_id.description
This field must exist on the `channels` database in the `id` column.

# paths./1/vod/channel/{channel}/share/{share}.patch.requestBody.content.application/json.schema.properties.player_id.description
This field must exist on the `players` database in the `id` column.

# paths./1/vod/channel/{channel}/share/{share}.patch.requestBody.content.application/json.schema.properties.encoding_id.description
This field must be present and not empty if the `target_type` field is equal to any of the following:`vod_media`
This field must exist on the `encodings` database in the `id` column.

# paths./1/vod/channel/{channel}/share/{share}/token.post.description
Create a token from a share, please take care to add https://player.vod2.infomaniak.com and https://api.vod2.infomaniak.com when using allowed_domains along when using infomaniak player

# paths./1/vod/channel/{channel}/upload.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/upload.post.description
Creates new Media with either
$post = ['folder' => $folderIdentifier, 'filename' => $fileName, 'url' => $videoUrl]; // uploading file from url
$post = ['folder' => $folderIdentifier, 'name' => $fileName, 'file' => new \CURLFile($filePath, '', $fileName)]; // uploading file

# paths./1/vod/encoding/constraint.get.summary
List major encoding constraints that should be respected

# paths./1/vod/encoding/constraint.get.description
in order to guarantee correct output encoding in most cases.

Still, following these rules may lead to incorrect encodings.
For example, trying to encode something into a flv container
will fail if the audio sampling rate is not 44100, 22050 or 11025 Hz.

# paths./1/vod/country.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/category.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/language.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/vod/channel/{channel}/statistics/time_ip.get.description
Get consumed time per ip : might timeout if there's too much values to return

# paths./1/vod/channel/{channel}/statistics/viewers/encodings/histogram.get.summary
Get channel viewers per encoding histogram

# paths./1/vod/channel/{channel}/statistics/viewers/encodings/histogram.get.description
Get channel viewers per encoding histogram

# paths./1/vod/channel/{channel}/statistics/media/{media}/viewers/encodi.get.summary
Get media viewers per encoding histogram

# paths./1/vod/channel/{channel}/statistics/media/{media}/viewers/encodi.get.description
Get media viewers per encoding histogram

# paths./1/newsletters/{domain}.get.description
Returns a variety of information about one Domain from a Domain identifier

# paths./1/newsletters/{domain}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/dashboard.get.parameters[].description
Unique identifier of the `Domain` to request

# paths./1/newsletters/{domain}/dashboard.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/dashboard/campaigns.get.parameters[].description
Unique identifier of the `Domain` to request

# paths./1/newsletters/{domain}/dashboard/campaigns.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/dashboard/stats/subscribers.get.description
Returns statistics about subscribers for a specific period

# paths./1/newsletters/{domain}/dashboard/stats/subscribers.get.parameters[].description
Unique identifier of the `Domain` to request

# paths./1/newsletters/{domain}/dashboard/stats/campaigns.get.description
Returns statistics about campaigns for a specific period

# paths./1/newsletters/{domain}/dashboard/stats/campaigns.get.parameters[].description
Unique identifier of the `Domain` to request

# paths./1/newsletters/{domain}/dashboard/stats/campaigns/monthly.get.description
Returns monthly campaigns statistics with aggregated metrics

# paths./1/newsletters/{domain}/dashboard/stats/campaigns/monthly.get.parameters[].description
Unique identifier of the `Domain` to request

# paths./1/newsletters/{domain}/campaigns.get.description
Returns a variety of information about one or more Campaigns

# paths./1/newsletters/{domain}/campaigns.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/campaigns.get.parameters[].schema.properties.provider_id.description
Unique identifier of the `Provider` to request

# paths./1/newsletters/{domain}/campaigns.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/campaigns.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/campaigns.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/campaigns.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/campaigns.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/campaigns.post.description
Create a campaign with the given parameters

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.closure.description
Defines the logical operator applied to the conditions array (conds) <br> "OR" means at least one condition must match

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.closure.description
Logical operator for nested conditions <br> "AND" means all inner conditions must match

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.actionId.description
Defines which campaigns to consider.

all: any campaign ever

any: any campaign in the last 30 days

last5: one of the last 5 campaigns

custom: a specific campaign (requires campaign_id)

Required only when type = "campaign"

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.campaign_id.description
ID of the specific campaign to check.
Required only if actionId = "custom"

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.date1.description
Start date for subscription date filter (format: Y-m-d).
Required when type = "created_at"

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.date2.description
End date for date range filtering.
Required only when operator = "between"
Must be after or equal to date1

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.mailinglist_id.description
ID of the mailing list to check subscription status.
Required when type = "mailinglist"

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.meta_id.description
ID of the subscriber custom field (meta field).
Required when type = "meta"

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.operator.description
Logical operator for the condition, varies by type:

campaign: "open", "click", "sent", "noopen", "noclick", "nosent"

created_at: "=", ">", "<", "between"

meta: "=", "<>", "like", "not like", "start", "finish"

mailinglist: "include", "exclude"

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.value.description
Value to compare against the meta field.
Used with operators like "=", "like", etc.
Required when type = "meta"

# paths./1/newsletters/{domain}/campaigns.post.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.id.description
Unique identifier of the resource `{name}`

# paths./1/newsletters/{domain}/campaigns/{campaign}.get.description
Returns a variety of information about one Campaign identifier

# paths./1/newsletters/{domain}/campaigns/{campaign}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.closure.description
Defines the logical operator applied to the conditions array (conds) <br> "OR" means at least one condition must match

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.closure.description
Logical operator for nested conditions <br> "AND" means all inner conditions must match

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.actionId.description
Defines which campaigns to consider.

all: any campaign ever

any: any campaign in the last 30 days

last5: one of the last 5 campaigns

custom: a specific campaign (requires campaign_id)

Required only when type = "campaign"

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.campaign_id.description
ID of the specific campaign to check.
Required only if actionId = "custom"

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.date1.description
Start date for subscription date filter (format: Y-m-d).
Required when type = "created_at"

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.date2.description
End date for date range filtering.
Required only when operator = "between"
Must be after or equal to date1

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.mailinglist_id.description
ID of the mailing list to check subscription status.
Required when type = "mailinglist"

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.meta_id.description
ID of the subscriber custom field (meta field).
Required when type = "meta"

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.operator.description
Logical operator for the condition, varies by type:

campaign: "open", "click", "sent", "noopen", "noclick", "nosent"

created_at: "=", ">", "<", "between"

meta: "=", "<>", "like", "not like", "start", "finish"

mailinglist: "include", "exclude"

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.conditions.properties.conds.items.properties.conds.items.properties.value.description
Value to compare against the meta field.
Used with operators like "=", "like", etc.
Required when type = "meta"

# paths./1/newsletters/{domain}/campaigns/{campaign}.put.requestBody.content.application/json.schema.properties.recipients.properties.expert.properties.id.description
Unique identifier of the resource `{name}`

# paths./1/newsletters/{domain}/campaigns/{campaign}/tracking.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/campaigns/{campaign}/tracking.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/campaigns/{campaign}/tracking.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/campaigns/{campaign}/tracking.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/campaigns/{campaign}/tracking.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/campaigns/{campaign}/report/links.get.description
Return statistics about links for a campaign

# paths./1/newsletters/{domain}/campaigns/{campaign}/report/activity.get.description
Return statistics about subscribers for a campaign

# paths./1/newsletters/{domain}/campaigns/{campaign}/report/activity.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/subscribers.get.description
Returns a variety of information about one or more Subscribers

# paths./1/newsletters/{domain}/subscribers.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/subscribers.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/subscribers.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/subscribers.post.description
Create a subscriber.

If a subscriber already exists, it will be updated with new values.
This is non-destructive operation, omitted parameters will not affect the subscriber.

# paths./1/newsletters/{domain}/subscribers.post.requestBody.content.application/json.schema.properties.fields.description
Object keys must correspond to field's key.

# paths./1/newsletters/{domain}/subscribers.post.requestBody.content.application/json.schema.properties.groups.description
An array of valid identifiers or the names of groups to be created.

# paths./1/newsletters/{domain}/subscribers.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/subscribers.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/subscribers.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/subscribers/count_status.get.description
Count subscribers in every status for a given domain

# paths./1/newsletters/{domain}/subscribers/{subscriber}.get.description
Returns a variety of information about one Subscriber

# paths./1/newsletters/{domain}/subscribers/{subscriber}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/subscribers/{subscriber}.put.description
Update a subscriber with new values.

This is non-destructive operation, omitted parameters will not affect the subscriber.

# paths./1/newsletters/{domain}/subscribers/{subscriber}.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/subscribers/{subscriber}.put.requestBody.content.application/json.schema.properties.fields.description
Object keys must correspond to field's key. Omitted values will be deleted.

# paths./1/newsletters/{domain}/subscribers/{subscriber}.put.requestBody.content.application/json.schema.properties.groups.description
An array of valid identifiers or the names of groups to be created.

# paths./1/newsletters/{domain}/subscribers/{subscriber}.delete.description
It will remove the subscriber from your account, but all their information is still kept in case they re-subscribe to your list.

If you need, to forget a subscriber use /forget.

# paths./1/newsletters/{domain}/subscribers/import/workspace.get.description
List all worspace adressebook with subscriber count

# paths./1/newsletters/{domain}/subscribers/import/workspace.post.description
Get selected contacts from Infomaniak workspace and prepare them for field match step

# paths./1/newsletters/{domain}/subscribers/import/workspace.post.requestBody.content.application/json.schema.properties.addressbooks.items.properties.id.description
Unique identifier of the resource `{name}`

# paths./1/newsletters/{domain}/subscribers/import/workspace.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./1/newsletters/{domain}/subscribers/import/workspace.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.bad_request: Triggered when the request is not well build.

# paths./1/newsletters/{domain}/subscribers/import/workspace.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/groups.get.description
List all groups

Returns a variety of information about one or more Groups

# paths./1/newsletters/{domain}/groups.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/groups.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/groups.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/groups.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/groups.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/groups.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/groups/{group}.get.description
Fetch a group

Returns a variety of information about one Groups identifier

# paths./1/newsletters/{domain}/groups/{group}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/groups/{group}/subscribers.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/groups/{group}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/groups/{group}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/groups/{group}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/groups/{group}/subscribers.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/groups/{group}/subscribers.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/credits.get.description
Returns a variety of information about one or more Credits

# paths./1/newsletters/{domain}/credits.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/credits.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/credits.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/credits/accounts.get.description
Returns a variety of information about credits for an account

# paths./1/newsletters/{domain}/credits/accounts.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/credits/accounts.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/credits/accounts.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/credits/checkout/{id}.get.description
Redirect the user to check out after choosing a credit pack

# paths./1/newsletters/{domain}/segments.get.description
Returns a variety of information about one or more Segment

# paths./1/newsletters/{domain}/segments.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/segments.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/segments.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/segments.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/segments.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/segments.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.closure.description
Defines the logical operator applied to the conditions array (conds) <br> "OR" means at least one condition must match

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.closure.description
Logical operator for nested conditions <br> "AND" means all inner conditions must match

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.actionId.description
Defines which campaigns to consider.

all: any campaign ever

any: any campaign in the last 30 days

last5: one of the last 5 campaigns

custom: a specific campaign (requires campaign_id)

Required only when type = "campaign"

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.campaign_id.description
ID of the specific campaign to check.
Required only if actionId = "custom"

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.date1.description
Start date for subscription date filter (format: Y-m-d).
Required when type = "created_at"

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.date2.description
End date for date range filtering.
Required only when operator = "between"
Must be after or equal to date1

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.mailinglist_id.description
ID of the mailing list to check subscription status.
Required when type = "mailinglist"

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.meta_id.description
ID of the subscriber custom field (meta field).
Required when type = "meta"

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.operator.description
Logical operator for the condition, varies by type:

campaign: "open", "click", "sent", "noopen", "noclick", "nosent"

created_at: "=", ">", "<", "between"

meta: "=", "<>", "like", "not like", "start", "finish"

mailinglist: "include", "exclude"

# paths./1/newsletters/{domain}/segments.post.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.value.description
Value to compare against the meta field.
Used with operators like "=", "like", etc.
Required when type = "meta"

# paths./1/newsletters/{domain}/segments/{segment}.get.description
Returns a variety of information about one Segment identifier

# paths./1/newsletters/{domain}/segments/{segment}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/segments/{segment}.get.parameters[].schema.description
Unique identifier of the `Segment` to request

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.closure.description
Defines the logical operator applied to the conditions array (conds) <br> "OR" means at least one condition must match

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.closure.description
Logical operator for nested conditions <br> "AND" means all inner conditions must match

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.actionId.description
Defines which campaigns to consider.

all: any campaign ever

any: any campaign in the last 30 days

last5: one of the last 5 campaigns

custom: a specific campaign (requires campaign_id)

Required only when type = "campaign"

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.campaign_id.description
ID of the specific campaign to check.
Required only if actionId = "custom"

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.date1.description
Start date for subscription date filter (format: Y-m-d).
Required when type = "created_at"

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.date2.description
End date for date range filtering.
Required only when operator = "between"
Must be after or equal to date1

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.mailinglist_id.description
ID of the mailing list to check subscription status.
Required when type = "mailinglist"

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.meta_id.description
ID of the subscriber custom field (meta field).
Required when type = "meta"

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.operator.description
Logical operator for the condition, varies by type:

campaign: "open", "click", "sent", "noopen", "noclick", "nosent"

created_at: "=", ">", "<", "between"

meta: "=", "<>", "like", "not like", "start", "finish"

mailinglist: "include", "exclude"

# paths./1/newsletters/{domain}/segments/{segment}.put.requestBody.content.application/json.schema.properties.data.properties.conds.items.properties.conds.items.properties.value.description
Value to compare against the meta field.
Used with operators like "=", "like", etc.
Required when type = "meta"

# paths./1/newsletters/{domain}/segments/{segment}/subscribers.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/segments/{segment}/subscribers.get.parameters[].schema.description
Unique identifier of the `Segment` to request

# paths./1/newsletters/{domain}/segments/{segment}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/segments/{segment}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/segments/{segment}/subscribers.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/segments/{segment}/subscribers.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/segments/{segment}/subscribers.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/fields.get.description
Returns a variety of information about one or more Field

# paths./1/newsletters/{domain}/fields.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/fields.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/fields.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/fields.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/fields.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/templates.get.description
Returns a variety of information about one or more Templates

# paths./1/newsletters/{domain}/templates.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/templates.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/webforms.get.description
Returns a variety of information about one or more Webforms

# paths./1/newsletters/{domain}/webforms.get.parameters[].schema.description
Unique identifier of the `Domain` to request

# paths./1/newsletters/{domain}/webforms.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/webforms.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/webforms.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/webforms.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/webforms.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/webforms.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/webforms.post.requestBody.content.application/json.schema.properties.fields.items.properties.id.description
Unique identifier of the resource `{name}`

# paths./1/newsletters/{domain}/webforms.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/newsletters/{domain}/webforms.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/newsletters/{domain}/webforms.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/webforms.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/newsletters/{domain}/webforms.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/newsletters/{domain}/webforms.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/webforms/{webform}.get.description
Returns a variety of information about one Webform identifier

# paths./1/newsletters/{domain}/webforms/{webform}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/webforms/{webform}.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/webforms/{webform}.put.requestBody.content.application/json.schema.properties.fields.items.properties.id.description
Unique identifier of the resource `{name}`

# paths./1/newsletters/{domain}/webforms/{webform}.delete.parameters[].description
Unique identifier of the `Domain` to request

# paths./1/newsletters/{domain}/webforms/{webform}/fields.get.description
Return a variety of information about fields related to a webform

# paths./1/newsletters/{domain}/campaigns/template/{template_uuid}/test.post.description
Allow to send a test campaign to an email based on the campaign template uuid.

If the email is in the subscribers, custom fields will be filled

# paths./1/newsletters/{domain}/campaigns/{campaign}/template/{template}.post.description
Create a new template from an existing campaign.

# paths./1/newsletters/{domain}/campaigns/{campaign}/template/{template}.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/newsletters/{domain}/campaigns/{campaign}/template/{template}.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/newsletters/{domain}/campaigns/{campaign}/template/{template}.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/campaigns/{campaign}/test.post.description
Allow to send a test campaign to an email. If the email is in the subscribers, custom fields will be filled

# paths./1/newsletters/{domain}/subscribers/filter.post.description
Returns a variety of information about one or more Subscribers.

Allows advanced filters (e.g. segmentation).

# paths./1/newsletters/{domain}/subscribers/filter.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/newsletters/{domain}/subscribers/filter.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/subscribers/filter.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/subscribers/filter.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/subscribers/filter.post.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/newsletters/{domain}/subscribers/filter.post.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/newsletters/{domain}/subscribers/export.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/newsletters/{domain}/subscribers/export.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/newsletters/{domain}/subscribers/export.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/subscribers/import.post.description
Import subscribers from a upload id.

By default, if subscribers exists replace the custom fields with the new values

# paths./1/newsletters/{domain}/subscribers/import.post.requestBody.content.application/json.schema.properties.fields.items.description
The field’s ID or its description (type and name)

# paths./1/newsletters/{domain}/subscribers/import.post.requestBody.content.application/json.schema.properties.fields.description
Object keys must correspond to field's id (integer), or its description (type + name).

# paths./1/newsletters/{domain}/subscribers/import.post.requestBody.content.application/json.schema.properties.groups.description
An array of valid identifiers or the names of groups to be created.

# paths./1/newsletters/{domain}/subscribers/import.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/newsletters/{domain}/subscribers/import.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/newsletters/{domain}/subscribers/import.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/subscribers/import/upload.post.description
Upload a csv file with subscribers to be processed

# paths./1/newsletters/{domain}/subscribers/{subscriber}/forget.delete.description
It will remove the subscriber from your account and all information will be completely deleted in 30 days.

This feature is GDPR compliant.

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.bad_request: Triggered when the request is not well build.

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/newsletters/{domain}/operations/{operationId}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/campaigns/{campaign}/cancel.put.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./1/newsletters/{domain}/campaigns/{campaign}/cancel.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.bad_request: Triggered when the request is not well build.

# paths./1/newsletters/{domain}/campaigns/{campaign}/cancel.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/newsletters/{domain}/subscribers/assign.put.requestBody.content.application/json.schema.properties.groups.description
An array of valid identifiers or the names of groups to be created.

# paths./1/newsletters/{domain}/templates/{template}/update-thumbnails.put.description
Generate or update a thumbnail for the given template and return it's url

# paths./1/newsletters/{domain}/templates/{template}/update-thumbnails.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/newsletters/{domain}/templates/{template}/update-thumbnails.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/newsletters/{domain}/templates/{template}/update-thumbnails.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos.get.description
This endpoint allows you to retrieve all channels on the pack order.

# paths./1/videos.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/videos.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/videos.post.description
This endpoint allows you to create a channel.

# paths./1/videos/{channel}/events.get.description
This endpoint allows you to retrieve all Event.

# paths./1/videos/{channel}/events.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/events.post.description
This endpoint allows you to create an Event.

# paths./1/videos/{channel}/events.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/events.post.requestBody.content.application/json.schema.properties.access_country.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events.post.requestBody.content.application/json.schema.properties.authorize_country.description
Authorise or Prohibit countries to view the stream

# paths./1/videos/{channel}/events.post.requestBody.content.application/json.schema.properties.live_playlist_id.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events.post.requestBody.content.application/json.schema.properties.live_playlist_inactive_name.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events.post.requestBody.content.application/json.schema.properties.name.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events.post.requestBody.content.application/json.schema.properties.record.description
Activate the interrupt of the live event

# paths./1/videos/{channel}/events.post.requestBody.content.application/json.schema.properties.storage_machine_id.description
Unique identifier of the `storage space`

# paths./1/videos/{channel}/events.post.requestBody.content.application/json.schema.properties.timezone.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/encodes.post.description
This endpoint retrieve the data needed to configure an encoder to publish the
streams associated to the given channel.
If the channel is meant to be pulled, this will return an empty collection.

# paths./1/videos/{channel}/encodes.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/encodes.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/videos/{channel}/encodes.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/videos/{channel}/encodes.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/encodes.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/videos/{channel}/encodes.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/videos/{channel}/encodes.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/players.get.description
This endpoint allows you to retrieve all players.

# paths./1/videos/{channel}/players.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/videos/{channel}/players.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/videos/{channel}/players.post.description
This endpoint allows you to create a new player.

# paths./1/videos/{channel}/players.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.ads_url.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.control_active_color.description
a CSS hex color string (e.g. #fff or #ffffff)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.control_color.description
a CSS hex color string (e.g. #fff or #ffffff)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.controlbar_color.description
a CSS hex color string (e.g. #fff or #ffffff)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.countdown_days.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.countdown_hours.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.countdown_minutes.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.countdown_seconds.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.countdown_txt.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.description.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.facebook_back_link.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.geo_ip_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.interrupt_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.logo_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.name.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.preload_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.restrict_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.title.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.twitter_back_link.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.twitter_related.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players.post.requestBody.content.application/json.schema.properties.twitter_via.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.get.description
This endpoint allows you to retrieve a player.

# paths./1/videos/{channel}/players/{player}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}.get.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}.put.description
This endpoint allows you to update a player.

# paths./1/videos/{channel}/players/{player}.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}.put.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.ads_url.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.control_active_color.description
a CSS hex color string (e.g. #fff or #ffffff)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.control_color.description
a CSS hex color string (e.g. #fff or #ffffff)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.controlbar_color.description
a CSS hex color string (e.g. #fff or #ffffff)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.countdown_days.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.countdown_hours.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.countdown_minutes.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.countdown_seconds.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.countdown_txt.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.description.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.facebook_back_link.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.geo_ip_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.interrupt_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.logo_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.name.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.preload_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.restrict_img.description
a Base64-encoded image string (data:image/png;base64,...) or a valid storage5.infomaniak.com URL

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.title.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.twitter_back_link.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.twitter_related.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.requestBody.content.application/json.schema.properties.twitter_via.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.put.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/videos/{channel}/players/{player}.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./1/videos/{channel}/players/{player}.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/players/{player}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/videos/{channel}/players/{player}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/videos/{channel}/players/{player}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/players/{player}.post.description
This endpoint allows you to copy a player.

# paths./1/videos/{channel}/players/{player}.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}.post.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}.post.requestBody.content.application/json.schema.properties.name.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/players/{player}.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/videos/{channel}/players/{player}.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./1/videos/{channel}/players/{player}.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/players/{player}.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/videos/{channel}/players/{player}.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/videos/{channel}/players/{player}.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/players/{player}.delete.description
This endpoint allows you to delete a player.

# paths./1/videos/{channel}/players/{player}.delete.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}.delete.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}.delete.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}/ads.get.description
This endpoint allows you to retrieve all Ads.

# paths./1/videos/{channel}/players/{player}/ads.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/ads.get.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/ads.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}/ads.post.description
This endpoint allows you to create a new Ads.

# paths./1/videos/{channel}/players/{player}/ads.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/ads.post.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/ads.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}/ads/duplicate.post.description
This endpoint allows you to copy an Ads.

# paths./1/videos/{channel}/players/{player}/ads/duplicate.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/ads/duplicate.post.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/ads/duplicate.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/options/recording.get.description
This endpoint allows you to retrieve to get the recording config.

Create a channel from the given request for the order identified byt hte given ID.

NOTE: the current user must already have the video product
added to his account. Otherwise, this will fail.

# paths./1/videos/{channel}/options/recording.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording.put.description
This endpoint allows you to retrieve to update a Recording config.

# paths./1/videos/{channel}/options/recording.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording.put.requestBody.content.application/json.schema.properties.auto_record.description
Indicates whether the recording starts automatically when the stream begins.

# paths./1/videos/{channel}/options/recording.put.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/videos/{channel}/options/recording.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./1/videos/{channel}/options/recording.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/recording.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/videos/{channel}/options/recording.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/videos/{channel}/options/recording.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/recording.post.description
This endpoint allows you to retrieve to update a Recording config.

# paths./1/videos/{channel}/options/recording.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/videos/{channel}/options/recording.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./1/videos/{channel}/options/recording.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/recording.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/videos/{channel}/options/recording.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/videos/{channel}/options/recording.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/recording/instant.post.description
Try to instantly start a recording of the first stream meant to be recorded,
on the first given storage machine.

NOTE: this process is oversimplified.
It assumes that only the best quality stream is meant to be recorded
and that it will be sent to the first given storage machine only.

# paths./1/videos/{channel}/options/recording/instant.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording/instant.post.requestBody.content.application/json.schema.properties.diffusion_ends_at.description
The diffusion end time is required when auto_stop is enabled

# paths./1/videos/{channel}/options/recording/instant.post.requestBody.content.application/json.schema.properties.file_path.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/options/recording/instant.post.requestBody.content.application/json.schema.properties.fragment_duration.description
The fragment duration is required and must be at least 1 second.

# paths./1/videos/{channel}/options/recording/instant.delete.description
Try to stop the instant record identified of the channel identified
by the given channel ID.
If no such record exists for the channel or that the recording already stopped,
this will throw an error.

NOTES:
- it is possible to stop a recording even if the option has expired.
- at the moment a channel may only have one instant record at a time, so this will use the first found

# paths./1/videos/{channel}/options/recording/instant.delete.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording/storage.get.description
This endpoint allows you to retrieve all storage machine.

# paths./1/videos/{channel}/options/recording/storage.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording/storage.post.description
This endpoint allows you to create a new storage machine.

# paths./1/videos/{channel}/options/recording/storage.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording/storage.post.requestBody.content.application/json.schema.properties.auto_fragment_duration.description
Duration of the media fragment in seconds

# paths./1/videos/{channel}/options/recording/storage.post.requestBody.content.application/json.schema.properties.auto_record_name.description
Name assigned to the recorded media or file

# paths./1/videos/{channel}/options/recording/storage.post.requestBody.content.application/json.schema.properties.default.description
Indicates whether this is the default item (true/false)

# paths./1/videos/{channel}/options/recording/storage.post.requestBody.content.application/json.schema.properties.name.description
Name of the server or connection profile

# paths./1/videos/{channel}/options/recording/storage.post.requestBody.content.application/json.schema.properties.port.description
Port number for the connection (e.g., 21 for FTP, 22 for SFTP)

# paths./1/videos/{channel}/options/recording/storage.post.requestBody.content.application/json.schema.properties.protocol.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/options/recording/storage.post.requestBody.content.application/json.schema.properties.url_http.description
HTTP URL where the resource can be accessed

# paths./1/videos/{channel}/options/recording/storage.post.requestBody.content.application/json.schema.properties.use_path.description
Indicates whether the path should be used (true/false)

# paths./1/videos/{channel}/options/recording/storage/test.post.description
This method is used to test the connection to an FTP server to verify
whether the provided credentials and parameters allow for a successful connection.
It also performs a write test by attempting to create a temporary file
on the server to ensure that write permissions are properly configured.

# paths./1/videos/{channel}/options/recording/storage/test.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording/storage/test.post.requestBody.content.application/json.schema.properties.auto_fragment_duration.description
Duration of the media fragment in seconds

# paths./1/videos/{channel}/options/recording/storage/test.post.requestBody.content.application/json.schema.properties.auto_record_name.description
Name assigned to the recorded media or file

# paths./1/videos/{channel}/options/recording/storage/test.post.requestBody.content.application/json.schema.properties.default.description
Indicates whether this is the default item (true/false)

# paths./1/videos/{channel}/options/recording/storage/test.post.requestBody.content.application/json.schema.properties.name.description
Name of the server or connection profile

# paths./1/videos/{channel}/options/recording/storage/test.post.requestBody.content.application/json.schema.properties.port.description
Port number for the connection (e.g., 21 for FTP, 22 for SFTP)

# paths./1/videos/{channel}/options/recording/storage/test.post.requestBody.content.application/json.schema.properties.protocol.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/options/recording/storage/test.post.requestBody.content.application/json.schema.properties.url_http.description
HTTP URL where the resource can be accessed

# paths./1/videos/{channel}/options/recording/storage/test.post.requestBody.content.application/json.schema.properties.use_path.description
Indicates whether the path should be used (true/false)

# paths./1/videos/{channel}/options/timeshift.get.description
This endpoint allows you to retrieve to get a timeshift config.

# paths./1/videos/{channel}/options/timeshift.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/timeshift.put.description
This endpoint allows you to retrieve to update a timeshift config.

# paths./1/videos/{channel}/options/timeshift.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/timeshift.put.requestBody.content.application/json.schema.properties.enabled.description
Specify a limit before the interruption of live events in case of overrun

# paths./1/videos/{channel}/options/timeshift.put.requestBody.content.application/json.schema.properties.record_window_duration.description
Define how far your viewers can go back (max.: 240 minutes)

# paths./1/videos/{channel}/options/timeshift.put.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/videos/{channel}/options/timeshift.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./1/videos/{channel}/options/timeshift.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/timeshift.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/videos/{channel}/options/timeshift.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/videos/{channel}/options/timeshift.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/timeshift.post.description
This endpoint allows you to retrieve to create a timeshift config.

# paths./1/videos/{channel}/options/timeshift.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}.post.description
This endpoint allows you to retrieve to create the simulcast.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}.post.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}.post.requestBody.content.application/json.schema.properties.additional_config.properties.dest_id.description
Destination ID (page ID, group ID, or user ID)

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}.post.requestBody.content.application/json.schema.properties.additional_config.properties.dest_type.description
Destination type (myTimeline, page, group)

# paths./1/videos/order/{order}.get.description
Retrieve all info about the pack currently used by the account from
which the request was made. This includes pricing and excess data.
If the account has no active offer, this will throw an error.

# paths./1/videos/order/{order}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/order.get.description
Retrieve all info about the pack currently used by the account from
which the request was made. This includes pricing and excess data.
If the account has no active offer, this will throw an error.

# paths./1/videos/order.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/order.put.description
This endpoint allows you to update a Pack order.

# paths./1/videos/order.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/order.put.requestBody.content.application/json.schema.properties.allowed_excess.description
Specify a limit before the interruption of live events in case of overrun

# paths./1/videos/shop/prices.get.description
This endpoint allows you to retrieve get the price on the pack order.

# paths./1/videos/shop/descriptions.get.description
This endpoint allows you to retrieve get the description on the pack order.

# paths./1/videos/stats/consumption.get.description
This endpoint allows you to retrieve Global consumption all channel on the pack order.

# paths./1/videos/stats/consumption.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/consumption.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/consumption.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/consumption/channels/histogram.get.description
This endpoint allows you to retrieve Global Histogram per channel on the pack order.

# paths./1/videos/stats/consumption/channels/histogram.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/consumption/channels/histogram.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/consumption/channels/histogram.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers.get.description
This endpoint allows you to retrieve Global viewers on the pack order.

# paths./1/videos/stats/viewers.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/uniques.get.description
This endpoint allows you to retrieve Global unique viewers on the pack order.

# paths./1/videos/stats/viewers/uniques.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers/uniques.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers/uniques.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/uniques.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/uniques.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/histogram.get.description
This endpoint allows you to retrieve Global unique viewers histogram on the pack order.

# paths./1/videos/stats/viewers/histogram.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers/histogram.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/histogram.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/channels/histogram.get.description
This endpoint allows you to retrieve Global viewers histogram per channel.

# paths./1/videos/stats/viewers/channels/histogram.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers/channels/histogram.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers/channels/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/channels/histogram.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/channels/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewers/channels/shares.get.description
This endpoint allows you to retrieve Global viewers histogram share per channel.

# paths./1/videos/stats/viewers/channels/shares.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers/channels/shares.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewers/channels/shares.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewing.get.description
This endpoint allows you to retrieve Global Viewing histogram per channel.

# paths./1/videos/stats/viewing.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewing.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewing.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewing.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewing.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewing/channels/histogram.get.description
This endpoint allows you to retrieve Global Viewing histogram per channel.

# paths./1/videos/stats/viewing/channels/histogram.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewing/channels/histogram.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/viewing/channels/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewing/channels/histogram.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/viewing/channels/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/stats/geolocation/countries.get.description
This endpoint allows you to retrieve Global all countries on the pack order.

# paths./1/videos/stats/geolocation/countries.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/geolocation/countries.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/geolocation/countries.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/stats/geolocation/clusters.get.description
This endpoint allows you to retrieve Global unique viewers on the pack order.

# paths./1/videos/stats/geolocation/clusters.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/stats/geolocation/clusters.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/stats/geolocation/clusters.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}.get.description
This endpoint allows you to retrieve a channel.

# paths./1/videos/{channel}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}.put.description
This endpoint allows you to update a channel.

# paths./1/videos/{channel}.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}.delete.description
This endpoint allows you to delete a channel.

# paths./1/videos/{channel}.delete.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/thumbnail.get.description
This endpoint allows you to retrieve a Thumbnail in live on the steaming video.

# paths./1/videos/{channel}/thumbnail.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/monitor.get.description
This method returns information about a stream, such as:
the bitrate, the name of the audio and video codecs, etc.

# paths./1/videos/{channel}/monitor.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/stats/export_csv/{statistics}.get.description
This endpoint allows you to export stream stats.

# paths./1/videos/{channel}/stats/export_csv/{statistics}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/stats/export_csv/{statistics}.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/export_csv/{statistics}.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/consumption.get.description
This endpoint allows you to retrieve channel consumption stats.

# paths./1/videos/{channel}/stats/consumption.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/consumption.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/consumption.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/consumption.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/consumption.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/consumption.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/consumption/resolutions/histogram.get.description
This endpoint allows you to retrieve consumption Per resolution histogram.

# paths./1/videos/{channel}/stats/consumption/resolutions/histogram.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/consumption/resolutions/histogram.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/consumption/resolutions/histogram.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/consumption/resolutions/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/consumption/resolutions/histogram.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/consumption/resolutions/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/countries.get.description
This endpoint allows you to retrieve get countries.

# paths./1/videos/{channel}/stats/geolocation/countries.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/geolocation/countries.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/countries.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/countries.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/countries.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/countries.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/clusters.get.description
This endpoint allows you to retrieve get clusters.

# paths./1/videos/{channel}/stats/geolocation/clusters.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/geolocation/clusters.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/clusters.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/clusters.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/clusters.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/geolocation/clusters.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/browsers/shares.get.description
This endpoint allows you to retrieve get browsers share.

# paths./1/videos/{channel}/stats/technologies/browsers/shares.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/technologies/browsers/shares.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/technologies/browsers/shares.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/technologies/browsers/shares.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/browsers/shares.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/browsers/shares.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/players/shares.get.description
This endpoint allows you to retrieve get player share.

# paths./1/videos/{channel}/stats/technologies/players/shares.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/technologies/players/shares.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/technologies/players/shares.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/technologies/players/shares.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/players/shares.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/players/shares.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/os/shares.get.description
This endpoint allows you to retrieve get OS share.

# paths./1/videos/{channel}/stats/technologies/os/shares.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/technologies/os/shares.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/technologies/os/shares.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/technologies/os/shares.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/os/shares.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/technologies/os/shares.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers.get.description
This endpoint allows you to retrieve get viewers share.

# paths./1/videos/{channel}/stats/viewers.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/viewers.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/histogram.get.description
This endpoint allows you to retrieve get viewers Histogram share.

# paths./1/videos/{channel}/stats/viewers/histogram.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/viewers/histogram.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers/histogram.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/histogram.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/shares.get.description
This endpoint allows you to retrieve get viewers per resolution share.

# paths./1/videos/{channel}/stats/viewers/resolutions/shares.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/viewers/resolutions/shares.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/shares.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/shares.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/shares.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/shares.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/histogram.get.description
This endpoint allows you to retrieve get viewers per resolution histogram.

# paths./1/videos/{channel}/stats/viewers/resolutions/histogram.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/viewers/resolutions/histogram.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/histogram.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/histogram.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/resolutions/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/uniques.get.description
This endpoint allows you to retrieve get unique viewers.

# paths./1/videos/{channel}/stats/viewers/uniques.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/viewers/uniques.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers/uniques.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewers/uniques.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/uniques.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewers/uniques.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewing.get.description
This endpoint allows you to retrieve Global Viewing histogram per channel.

# paths./1/videos/{channel}/stats/viewing.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/viewing.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewing.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewing.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewing.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewing.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewing/resolutions/histogram.get.description
This endpoint allows you to retrieve Global Viewing histogram per channel.

# paths./1/videos/{channel}/stats/viewing/resolutions/histogram.get.parameters[].description
The unique identifier (ID) of the Pack order to request.

# paths./1/videos/{channel}/stats/viewing/resolutions/histogram.get.parameters[].description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewing/resolutions/histogram.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/stats/viewing/resolutions/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewing/resolutions/histogram.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/stats/viewing/resolutions/histogram.get.parameters[].description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/events/{repeatable_planned_event}.get.description
This endpoint allows you to retrieve an Event.

# paths./1/videos/{channel}/events/{repeatable_planned_event}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.description
This endpoint allows you to update an Event.

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.access_country.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.authorize_country.description
Authorise or Prohibit countries to view the stream

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.live_playlist_id.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.live_playlist_inactive_name.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.name.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.record.description
Activate the interrupt of the live event

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.storage_machine_id.description
Unique identifier of the `storage space`

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.timezone.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/events/{repeatable_planned_event}.put.requestBody.content.application/json.schema.properties.type.description
only:Change only this event,all:Change all event,from:Change this event and recurrences

# paths./1/videos/{channel}/events/{repeatable_planned_event}.delete.description
This endpoint allows you to delete an Event.

# paths./1/videos/{channel}/events/{repeatable_planned_event}.delete.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/integrations.get.description
This implies manual integration between the broadcast source and the broadcast method.

# paths./1/videos/{channel}/integrations.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/history.get.description
This endpoint allows you to retrieve a list of connection

# paths./1/videos/{channel}/history.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/history/{connection_history}.get.description
This endpoint allows you to retrieve a channel.

# paths./1/videos/{channel}/history/{connection_history}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/restrictions.get.description
This endpoint allows you to retrieve the restriction for the channels.

# paths./1/videos/{channel}/restrictions.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/restrictions.put.description
This endpoint allows you to update a restriction channel.

# paths./1/videos/{channel}/restrictions.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/restrictions.put.requestBody.content.application/json.schema.properties.access_country.description
Specify the ISO 3166-1 alpha-2 country code for access control.

# paths./1/videos/{channel}/restrictions.put.requestBody.content.application/json.schema.properties.allow_domain.description
Allow access only from this domain (e.g., example.com).

# paths./1/videos/{channel}/restrictions.put.requestBody.content.application/json.schema.properties.authorize_country.description
Set to true to restrict access to specific countries.

# paths./1/videos/{channel}/restrictions.put.requestBody.content.application/json.schema.properties.exception_ip.description
Comma-separated list of IPs that bypass restrictions.

# paths./1/videos/{channel}/restrictions.put.requestBody.content.application/json.schema.properties.forbidden_ip.description
An IP address that is explicitly blocked (stored as integer).

# paths./1/videos/{channel}/restrictions.put.requestBody.content.application/json.schema.properties.shared_key.description
Shared key for validating access or external system auth.

# paths./1/videos/{channel}/restrictions/geographical.get.summary
Retrieves the geographical restrictions applicable to a channel over a given period.

# paths./1/videos/{channel}/restrictions/geographical.get.description
This method:
- Sets a default period of 30 days back if no 'start' parameter is provided.
- Sets the end date to "now" if no 'end' parameter is provided.
- Query the service to obtain the corresponding geographical restrictions.
- Returns restrictions in the form of an indexed table via a dedicated Resource.

# paths./1/videos/{channel}/restrictions/geographical.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/restrictions/geographical.get.parameters[].schema.description
Specify the starting date to get Consumption

# paths./1/videos/{channel}/restrictions/geographical.get.parameters[].schema.description
Specify the ending date to get Consumption

# paths./1/videos/{channel}/players/{player}/thumbnail/{thumbnail}.get.description
This endpoint allows you to retrieve a Vignette for the player.

# paths./1/videos/{channel}/players/{player}/thumbnail/{thumbnail}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/thumbnail/{thumbnail}.get.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/thumbnail/{thumbnail}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}/embed.get.description
Integrate the player into your site by cutting / pasting the HTML5 code below.

# paths./1/videos/{channel}/players/{player}/embed.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/embed.get.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/embed.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}/embed/url.get.description
Try to retrieve the parameters needed to construct an iframe for the player identified by the given
player ID for the given channel, or for the last updated player of the channel, if any.
If the channels hasn't any player and that no player ID is provided,
it will return parameters for a default player.

If the channels doesn't exist or that the player isn't linked to the channel,
or that the channel is badly configured, this will throw an error.

# paths./1/videos/{channel}/players/{player}/embed/url.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/embed/url.get.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/embed/url.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.get.description
This endpoint allows you to retrieve an Ads.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.get.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.get.parameters[].description
The unique identifier (ID) of the ads to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.put.description
This endpoint allows you to update an Ads.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.put.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.put.parameters[].description
The unique identifier (ID) of the ads to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/videos/{channel}/players/{player}/ads/{ads}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/players/{player}/ads/{ads}.delete.description
This endpoint allows you to create an Ads.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.delete.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.delete.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.delete.parameters[].description
The unique identifier (ID) of the ads to request.

# paths./1/videos/{channel}/players/{player}/ads/{ads}.delete.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/options.get.description
This endpoint allows you to retrieve to see all option of the  channel.

# paths./1/videos/{channel}/options.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/{video_option}.get.description
This endpoint allows you to retrieve option.

# paths./1/videos/{channel}/options/{video_option}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.get.description
This endpoint allows you to retrieve a storage machine.

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.description
This endpoint allows you to update a storage machine.

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.requestBody.content.application/json.schema.properties.auto_fragment_duration.description
Duration of the media fragment in seconds

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.requestBody.content.application/json.schema.properties.auto_record_name.description
Name assigned to the recorded media or file

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.requestBody.content.application/json.schema.properties.default.description
Indicates whether this is the default item (true/false)

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.requestBody.content.application/json.schema.properties.name.description
Name of the server or connection profile

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.requestBody.content.application/json.schema.properties.port.description
Port number for the connection (e.g., 21 for FTP, 22 for SFTP)

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.requestBody.content.application/json.schema.properties.protocol.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.requestBody.content.application/json.schema.properties.url_http.description
HTTP URL where the resource can be accessed

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.requestBody.content.application/json.schema.properties.use_path.description
Indicates whether the path should be used (true/false)

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.delete.description
This endpoint allows you to delete a storage machine.

# paths./1/videos/{channel}/options/recording/storage/{storage_machine}.delete.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/watermark.get.description
This endpoint allows you to retrieve to get the watermark.

# paths./1/videos/{channel}/options/watermark.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/watermark.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/options/watermark.put.description
This endpoint allows you to retrieve to update or create the watermark.

# paths./1/videos/{channel}/options/watermark.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/watermark.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/options/watermark.put.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/videos/{channel}/options/watermark.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./1/videos/{channel}/options/watermark.put.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/options/watermark.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/videos/{channel}/options/watermark.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/videos/{channel}/options/watermark.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/simulcasts.get.description
This endpoint allows you to retrieve to get the simulcast.

# paths./1/videos/{channel}/simulcasts.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.get.description
This endpoint allows you to retrieve to get the simulcast.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.get.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.description
This endpoint allows you to retrieve to update the simulcast.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.requestBody.content.application/json.schema.properties.additional_config.properties.dest_id.description
Destination ID (page ID, group ID, or user ID)

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.requestBody.content.application/json.schema.properties.additional_config.properties.dest_type.description
Destination type (myTimeline, page, group)

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.requestBody.content.application/json.schema.properties.host.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.delete.description
This endpoint allows you to retrieve to delete the player.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.delete.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/countries.get.description
List all the countries available for anything as Code => Name.

# paths./1/videos/timezones.get.description
List all the timezones available for  "America/Asuncion": "(GMT-03:00) Asuncion",.

# paths./1/videos/password.get.description
Generate a random password string in base 52 (0-9a-zA-Z minus aeiouAEIOU).
The first 5 vowels have been removed to avoid bad luck passwords
(1fUcky0u for example).

# paths./1/videos/password.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/videos/password.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.method_not_found: Triggered the asked API route is not accessible.

# paths./1/videos/password.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/videos/{channel}/live/start.put.description
Attempt to resume the live if interrupted or does nothing otherwise.

# paths./1/videos/{channel}/live/start.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/live/start.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/live/stop.put.description
Attempt to interrupt the live if not already interrupted or does nothing otherwise.

# paths./1/videos/{channel}/live/stop.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/live/stop.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/restrictions/password.put.description
This endpoint allows you to update a restriction password channel.

# paths./1/videos/{channel}/restrictions/password.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/restrictions/password.put.requestBody.content.application/json.schema.properties.pass_stream.description
a strict string (no HTML/PHP tags or HTML entities allowed)

# paths./1/videos/{channel}/options/{video_option}/recommit.put.description
This WILL NOT restore an option effectively terminated, regardless of whether the option has been
instantly terminated or its termination date has been reached.

If the given option has already been marked for termination for the given channel
then this won't do anything.

# paths./1/videos/{channel}/options/{video_option}/recommit.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/watermark/enable.put.description
This endpoint allows you to retrieve to enable the watermark.

# paths./1/videos/{channel}/options/watermark/enable.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/watermark/enable.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/options/watermark/disable.put.description
This endpoint allows you to retrieve to enable the watermark.

# paths./1/videos/{channel}/options/watermark/disable.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/watermark/disable.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.description
This endpoint allows you to retrieve to enable the simulcast.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.description
This endpoint allows you to retrieve to disable the simulcast.

# paths./1/videos/{channel}/simulcasts/{simulcast_platform}/{simulcast_c.put.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/videos/{channel}/options/{video_option}/terminate.delete.description
This endpoint allows you to retrieve to terminate the option.

# paths./1/videos/{channel}/options/{video_option}/terminate.delete.parameters[].description
The unique identifier (ID) of the channel to request.

# paths./1/swiss_backups/{swiss_backup_id}/admin.put.description
Update the email address for the Acronis administrator user

# paths./1/swiss_backups/{swiss_backup_id}/admin/request_password.post.description
Get a new token or send an email, to change the Acronis administrator password

# paths./1/swiss_backups/{swiss_backup_id}/admin/request_password.post.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots.get.description
Get all slots for the given Swiss Backup product

# paths./1/swiss_backups/{swiss_backup_id}/slots.get.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots.post.description
Create a new slot via a job, for the given Swiss Backup

# paths./1/swiss_backups/{swiss_backup_id}/slots.post.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots.post.requestBody.content.application/json.schema.properties.lang.description
Language identifier (1 = fr / 2 = en / 3 = de / 4 = it / 5 = es)

# paths./1/swiss_backups/{swiss_backup_id}/slots.post.requestBody.content.application/json.schema.properties.size.description
Total storage size of the Swiss Backup product (Bytes)

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/disable.post.description
Disable a slot via a job, for the given Swiss Backup

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/disable.post.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/disable.post.parameters[].description
Unique identifier of the Slot to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/enable.post.description
Enable a slot via a job, for the given Swiss Backup

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/enable.post.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/enable.post.parameters[].description
Unique identifier of the Slot to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/request_passw.post.description
Get a new token or send the email, to change the password for a slot

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/request_passw.post.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/request_passw.post.parameters[].description
Unique identifier of the Slot to request.

# paths./1/swiss_backups.get.description
List all Swiss Backup products for the given account

# paths./1/swiss_backups.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/swiss_backups.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/swiss_backups.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/swiss_backups/{swiss_backup_id}.get.description
Get details for the given Swiss Backup product

# paths./1/swiss_backups/{swiss_backup_id}.get.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}.put.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}.put.requestBody.content.application/json.schema.properties.storage_reserved_acronis.description
Allocated storage size for Acronis (Bytes)

# paths./1/swiss_backups/{swiss_backup_id}/acronis_informations.get.description
Get Acronis information, from the Acronis API, for the given Swiss Backup product

# paths./1/swiss_backups/{swiss_backup_id}/acronis_informations.get.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.get.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.get.parameters[].description
Unique identifier of the Slot to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.put.description
Update a slot via a job, for the given Swiss Backup

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.put.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.put.parameters[].description
Unique identifier of the Slot to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.put.requestBody.content.application/json.schema.properties.activate_notifications.description
True if the user wants to receive Acronis notifications

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.put.requestBody.content.application/json.schema.properties.lang.description
Language identifier (1 = fr / 2 = en / 3 = de / 4 = it / 5 = es)

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.put.requestBody.content.application/json.schema.properties.size.description
Total storage size of the Swiss Backup product (Bytes)

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.delete.description
Delete a slot for the given Swiss Backup

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.delete.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}.delete.parameters[].description
Unique identifier of the Slot to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/rclone.get.parameters[].description
Unique identifier of the Swiss Backup to request.

# paths./1/swiss_backups/{swiss_backup_id}/slots/{slot_id}/rclone.get.parameters[].description
Unique identifier of the Slot to request.

# paths./1/swiss_backups/pricing.get.description
List all prices and discounts for Swiss Backup products

# paths./1/swiss_backups/pricing.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/swiss_backups/calculate.get.description
Calculate the price for a specific configuration

# paths./1/swiss_backups/calculate.get.parameters[].schema.description
Total storage size of the Swiss Backup product (Bytes)

# paths./1/radios/packs.get.description
This endpoint allows you to retrieve all the packs.

# paths./1/radios/packs.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/radios/packs.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/packs.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/options.get.description
This endpoint allows you to retrieve all the options.

# paths./1/radios/options.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/options.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/streams/{stream_uuid}/playlist.get.description
This endpoint allows you to get playlist file with stream url.

# paths./1/radios/streams/{stream_uuid}/playlist.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/streams/{stream_uuid}/playlist.get.parameters[].schema.description
The playlist typeasx,asx: Asx pls,pls: Pls qtl,qtl: Qtl ram,ram: Ram xspf,xspf: Xspf m3u,m3u: M3u

# paths./1/radios/streams/{stream_uuid}/playlist.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/streams/{stream_uuid}/playlist.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/streams/{stream_uuid}/playlist.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/streams/{stream_uuid}/introduction-file.get.description
This endpoint allows you to get the introduction file for a stream.

# paths./1/radios/streams/{stream_uuid}/introduction-file.get.parameters[].description
The universal unique identifier (ID) of the stream to request.

# paths./1/radios/streams/{stream_uuid}/introduction-file.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/streams/{stream_uuid}/introduction-file.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/streams/{stream_uuid}/introduction-file.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/playlist/{any}.get.description
This endpoint allows you to get playlist file with legacy parameters.

# paths./1/radios/playlist/{any}.get.parameters[].schema.description
The playlist typeasx,asx: Asx pls,pls: Pls qtl,qtl: Qtl ram,ram: Ram xspf,xspf: Xspf m3u,m3u: M3u

# paths./1/radios/playlist/{any}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/playlist/{any}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/playlist/{any}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/players/{player_uuid}/config.get.description
This endpoint allows you to get the player config.

# paths./1/radios/players/{player_uuid}/config.get.parameters[].description
The universally unique identifier (UUID) of the player to request.

# paths./1/radios/players/{player_uuid}/config.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/players/{player_uuid}/config.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/players/{player_uuid}/config.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/players/{player_uuid}/config.post.description
This endpoint allows you to get the player config.

# paths./1/radios/players/{player_uuid}/config.post.parameters[].description
The universally unique identifier (UUID) of the player to request.

# paths./1/radios/players/{player_uuid}/config.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/players/{player_uuid}/config.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/players/{player_uuid}/config.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/stats/status.get.description
This endpoint allows you to get status from streams of a station.

# paths./1/radios/stats/status.get.parameters[].schema.description
Specify the type of return for the data (default:xml)

# paths./1/radios/stats/status.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/stats/status.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/stats/status.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/stats/listeners.get.description
This endpoint allows you to get instant listeners on streams of a station.

# paths./1/radios/stats/listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/stats/listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/stats/listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/stats/sum-listeners.get.description
This endpoint allows you to get stats listeners on a stream.

# paths./1/radios/stats/sum-listeners.get.parameters[].schema.description
Specify the type of return for the data (default:xml)

# paths./1/radios/stats/sum-listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/stats/sum-listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/stats/sum-listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/stats/sum-listeners-on-product.get.description
This endpoint allows you to get stats listeners on a stream.

# paths./1/radios/stats/sum-listeners-on-product.get.parameters[].schema.description
Specify the type of return for the data (default:xml)

# paths./1/radios/stats/sum-listeners-on-product.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/stats/sum-listeners-on-product.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/stats/sum-listeners-on-product.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/stats/mediastats.get.description
This endpoint allows you to get mediastats listeners on a stream.

# paths./1/radios/stats/mediastats.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/stats/mediastats.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/stats/mediastats.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/stats/metadata.get.description
This endpoint allows you to set metadata to a station.

# paths./1/radios/stats/metadata.get.parameters[].schema.description
Specify the metadata for the station (same as push)

# paths./1/radios/stats/metadata.get.parameters[].schema.description
Specify the metadata for the station (same as data)

# paths./1/radios/stats/metadata.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/stats/metadata.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/stats/metadata.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/radio/diag/status.php.get.description
This endpoint allows you to get status from streams of a station.

# paths./1/radios/radio/diag/status.php.get.parameters[].schema.description
Specify the type of return for the data (default:xml)

# paths./1/radios/radio/diag/status.php.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/radio/diag/status.php.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/radio/diag/status.php.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/updatemetadata.php.get.description
This endpoint allows you to set metadata to a station.

# paths./1/radios/updatemetadata.php.get.parameters[].schema.description
Specify the metadata for the station (same as push)

# paths./1/radios/updatemetadata.php.get.parameters[].schema.description
Specify the metadata for the station (same as data)

# paths./1/radios/updatemetadata.php.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/updatemetadata.php.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/updatemetadata.php.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/mediastats.php.get.description
This endpoint allows you to get mediastats listeners on a stream.

# paths./1/radios/mediastats.php.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/mediastats.php.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/mediastats.php.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/listclients.xml.get.description
This endpoint allows you to get mediastats listeners on a stream.

# paths./1/radios/listclients.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/listclients.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/listclients.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/admin/stats.xml.get.description
This endpoint allows you to get stats listeners on a stream.

# paths./1/radios/admin/stats.xml.get.parameters[].schema.description
Specify the type of return for the data (default:xml)

# paths./1/radios/admin/stats.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/admin/stats.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/admin/stats.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/admin/stats.get.description
This endpoint allows you to get stats listeners on a stream.

# paths./1/radios/admin/stats.get.parameters[].schema.description
Specify the type of return for the data (default:xml)

# paths./1/radios/admin/stats.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/admin/stats.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/admin/stats.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/admin/stats_group.xml.get.description
This endpoint allows you to get stats listeners on a stream.

# paths./1/radios/admin/stats_group.xml.get.parameters[].schema.description
Specify the type of return for the data (default:xml)

# paths./1/radios/admin/stats_group.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/admin/stats_group.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/admin/stats_group.xml.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios.get.description
This endpoint allows you to retrieve all the products.

# paths./1/radios.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/radios.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}.get.description
This endpoint allows you to retrieve a product.

# paths./1/radios/{radio_product_id}.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/radios/{radio_product_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}.put.description
This endpoint allows you to update a product.

# paths./1/radios/{radio_product_id}.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/users.get.description
This endpoint allows you to retrieve all users attach to the product.

# paths./1/radios/{radio_product_id}/users.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/conflict_restrictions.get.summary
Get the list of stream in conflict with an update of restrictions

# paths./1/radios/{radio_product_id}/conflict_restrictions.get.parameters[].schema.description
Specify the country list not allow accessing to the stream

# paths./1/radios/{radio_product_id}/conflict_restrictions.get.parameters[].schema.description
Specify the ip list not allow accessing to the stream

# paths./1/radios/{radio_product_id}/conflict_restrictions.get.parameters[].schema.description
Specify the ip list allow accessing to the stream

# paths./1/radios/{radio_product_id}/conflict_restrictions.get.parameters[].schema.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/conflict_restrictions.get.parameters[].schema.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/stations.get.description
This endpoint allows you to retrieve all the stations.

# paths./1/radios/{radio_product_id}/stations.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/radios/{radio_product_id}/stations.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/{radio_product_id}/stations.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/stations.post.description
This endpoint allows you to store a station.

# paths./1/radios/{radio_product_id}/stations.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations.post.requestBody.content.application/json.schema.properties.is_daily_restart.description
Specify if the station will restart daily

# paths./1/radios/{radio_product_id}/stations.post.requestBody.content.application/json.schema.properties.time_daily_restart.description
Specify at which moment the daily restart begin

# paths./1/radios/{radio_product_id}/stations.post.requestBody.content.application/json.schema.properties.timezone_daily_restart.description
Specify the timezone of the daily restart

# paths./1/radios/{radio_product_id}/stations.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.description
This endpoint allows you to update a station.

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.requestBody.content.application/json.schema.properties.is_daily_restart.description
Specify if the station will restart daily

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.requestBody.content.application/json.schema.properties.is_enabled.description
Specify if you enable or disable the diffusion of all streams

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.requestBody.content.application/json.schema.properties.log_password.description
The password to connect to the log server

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.requestBody.content.application/json.schema.properties.log_server.description
The server name to connect to the log server

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.requestBody.content.application/json.schema.properties.time_daily_restart.description
Specify at which moment the daily restart begin

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.requestBody.content.application/json.schema.properties.timezone_daily_restart.description
Specify the timezone of the daily restart

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.description
This endpoint allows you to delete a station.

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.parameters[].schema.description
Specify the user password to check authorization

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/players.get.description
This endpoint allows you to retrieve all the players in a station.

# paths./1/radios/{radio_product_id}/stations/{station_id}/players.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/players.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/players.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/players.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/{radio_product_id}/stations/{station_id}/players.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/stations/{station_id}/server_events.get.description
This endpoint allows you to retrieve master and edge events by date.

# paths./1/radios/{radio_product_id}/stations/{station_id}/server_events.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/server_events.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/server_events.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/server_events.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/server_events.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/server_events.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/stations/{station_id}/encoder_event.get.description
This endpoint allows you to retrieve encoder events by date.

# paths./1/radios/{radio_product_id}/stations/{station_id}/encoder_event.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/encoder_event.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/encoder_event.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/encoder_event.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/encoder_event.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/encoder_event.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.description
This endpoint allows you to retrieve station listeners stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.description
This endpoint allows you to retrieve station listeners stats per minute.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.description
This endpoint allows you to retrieve station listeners stats per minute per stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/listene.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.description
This endpoint allows you to retrieve station countries stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.description
This endpoint allows you to retrieve station total countries stats by continent.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/countri.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.description
This endpoint allows you to retrieve station listeners stats by stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.parameters[].schema.description
Define if stream without listener are in the return

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/consump.get.description
This endpoint allows you to retrieve station consumption stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/consump.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/consump.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/consump.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/consump.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/consump.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/consump.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_c.get.description
This endpoint allows you to retrieve station total consumption stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_c.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_c.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_c.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_c.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_c.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_c.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.description
This endpoint allows you to retrieve station consumption stats by stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stream_.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/players.get.description
This endpoint allows you to retrieve players stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/players.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/players.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/players.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/players.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_p.get.description
This endpoint allows you to retrieve players total stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_p.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_p.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_p.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_p.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_p.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/total_p.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stats_b.get.description
This endpoint allows you to retrieve stats group by streams.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stats_b.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stats_b.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stats_b.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stats_b.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/stats_b.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.description
This endpoint allows you to export station stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].schema.description
Specify the timezone for the output date

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.description
This endpoint allows you to export station stats by stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].schema.description
Specify the timezone for the output date

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.parameters[].schema.description
Define if hls stream will be count in the stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/export_.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/links.get.description
This endpoint allows you to get all stats links.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/links.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/links.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/links.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/links.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/stats/links.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/mediapulse/ex.get.description
We generate the log from Elastic if not already exist
Return true if we start the generation

# paths./1/radios/{radio_product_id}/stations/{station_id}/mediapulse/ex.get.summary
Check if Mediapulse log file is already present in storage

# paths./1/radios/{radio_product_id}/stations/{station_id}/mediapulse/re.get.summary
Generate a report for export mediapulse log on a station

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.get.description
This endpoint allows you to retrieve the notification bind to the radio_product or station if it's exist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.description
This endpoint allows you to update a notification.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.end_hour.description
Specify the last hour of the day to receive notification

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_friday.description
Specify if the notification can be sent the friday

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_mail.description
Specify if the notification will be sent by mail

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_monday.description
Specify if the notification can be sent the monday

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_saturday.description
Specify if the notification can be sent the saturday

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_sms.description
Specify if the notification will be sent by sms

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_sunday.description
Specify if the notification can be sent the sunday

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_thursday.description
Specify if the notification can be sent the thursday

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_tuesday.description
Specify if the notification can be sent the tuesday

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.is_wednesday.description
Specify if the notification can be sent the wednesday

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.start_hour.description
Specify the begin hour of the day to receive notification

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.requestBody.content.application/json.schema.properties.users.description
Specify the list of account id will receive the notification

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/notification.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.description
This endpoint allows you to retrieve all the streams.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.description
This endpoint allows you to store a stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.country_list.description
Specify the country list not allow accessing to the stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.fallback_is_active_relay.description
Specify if the fallback is a relay stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.fallback_relay_mountpoint.description
Specify the relay mountpoint for the fallback

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.fallback_relay_port.description
Specify the relay server port for the fallback

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.fallback_relay_server.description
Specify the relay server domain for the fallback

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.ip_exclude_list.description
Specify the ip list not allow accessing to the stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.ip_include_list.description
Specify the ip list allow accessing to the stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.is_allow_country.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.is_fallback.description
Specify is the new stream have a fallback

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.requestBody.content.application/json.schema.properties.is_hash_restriction.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams.post.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve a stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.description
This endpoint allows you to update a stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.country_list.description
Specify the country list not allow accessing to the stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.fallback_is_active_relay.description
Specify if the fallback is a relay stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.fallback_relay_mountpoint.description
Specify the relay mountpoint for the fallback

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.fallback_relay_port.description
Specify the relay server port for the fallback

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.fallback_relay_server.description
Specify the relay server domain for the fallback

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.ip_exclude_list.description
Specify the ip list not allow accessing to the stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.ip_include_list.description
Specify the ip list allow accessing to the stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.is_allow_country.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.is_fallback.description
Specify is the new stream have a fallback

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.requestBody.content.application/json.schema.properties.is_hash_restriction.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.description
This endpoint allows you to delete a stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].schema.description
Specify the user password to check authorization

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to check real the bitrate of the stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to get the introduction file for a stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.description
This endpoint allows you to update the introduction file for a stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.requestBody.content.application/json.schema.properties.file.description
Specify the new introduction file for the stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.description
This endpoint allows you to delete the introduction file for a stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve stream listeners stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve stream listeners stats by minute on last 24h.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve stream countries stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve stream total countries stats by continent.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve stream consumption stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve total stream consumption stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve players stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to retrieve players total stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.description
This endpoint allows you to export stream stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
Specify the timezone for the output date

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.get.description
This endpoint allows you to retrieve a hls stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.description
This endpoint allows you to update a hls stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.bitrates.description
Specify the bitrates available in the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.buffer_size.description
Specify the buffer size of the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.country_list.description
Specify the country list not allow accessing to the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.domains.description
Specify the domains allow accessing to the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.hash_key.description
Specify the token to protect the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.ip_exclude_list.description
Specify the ip list not allow accessing to the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.ip_include_list.description
Specify the ip list allow accessing to the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.is_allow_country.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.is_hash_restriction.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.requestBody.content.application/json.schema.properties.source_id.description
Specify the source stream of the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.description
This endpoint allows you to delete a hls stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.parameters[].schema.description
Specify the user password to check authorization

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to retrieve hls stream listeners stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to retrieve hls stream listeners stats by minute on last 24h.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to retrieve hls stream countries stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to retrieve hls stream total countries stats by continent.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to retrieve hls stream consumption stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to retrieve total hls stream consumption stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].schema.description
the type of the stream to query stats for

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to retrieve players stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to retrieve players total stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.description
This endpoint allows you to export hls stream stats.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.parameters[].schema.description
Specify the timezone for the output date

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/st.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.get.description
This endpoint allows you to retrieve an AutoDJ.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.description
This endpoint allows you to update an AutoDJ.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.requestBody.content.application/json.schema.properties.inject_cover_metadata.description
Inject the thumbnail URL into the title for cover player display

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.requestBody.content.application/json.schema.properties.is_live_priority.description
Specify if the live overwrite autodj when active

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.requestBody.content.application/json.schema.properties.is_normalized_song.description
Specify if the song is normalized with the others

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.requestBody.content.application/json.schema.properties.time_before_same_song.description
Specify the time before replay the same song

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.post.description
This endpoint allows you to store an AutoDJ.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.description
This endpoint allows you to get the playing playlist attached to AutoDJ.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.description
This endpoint allows you to get the playing playlist attached to AutoDJ.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.summary
This endpoint allows you to list AutoDJ events.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.description
*
* @api-summary       List AutoDJ Event
* @api_operation     ListAutoDJEvent

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.description
This endpoint allows you to store an AutoDJ event.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.requestBody.content.application/json.schema.properties.has_perfect_timing.description
Specify if the first song need to be played at the exactly starting time

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.requestBody.content.application/json.schema.properties.is_random.description
Specify if the song are selected randomly

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.requestBody.content.application/json.schema.properties.type_target.description
Specify the target id linked to the type

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.description
This endpoint allows you to retrieve an AutoDJ event.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.parameters[].description
The unique identifier (ID) of the event to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.description
This endpoint allows you to update an AutoDJ event.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.parameters[].description
The unique identifier (ID) of the event to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.requestBody.content.application/json.schema.properties.has_perfect_timing.description
Specify if the first song need to be played at the exactly starting time

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.requestBody.content.application/json.schema.properties.is_random.description
Specify if the song are selected randomly

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.requestBody.content.application/json.schema.properties.recurrence_id.description
Specify the recurrence_id to update event with recurrence

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.requestBody.content.application/json.schema.properties.scope.description
Specify the scope to update event and its recurrence

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.requestBody.content.application/json.schema.properties.type_target.description
Specify the target id linked to the type

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.delete.description
This endpoint allows you to delete an AutoDJ event.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.delete.parameters[].description
The unique identifier (ID) of the event to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.delete.parameters[].schema.description
Specify the scope to update event and its recurrence

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/events.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.summary
This endpoint allows you to list AutoDJ media.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.description
*
* @api-summary       List AutoDJ Media
* @api_operation     ListAutoDJMedia

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.post.description
This endpoint allows you to store an AutoDJ media.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.description
This endpoint allows you to retrieve an AutoDJ media.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.parameters[].description
The unique identifier (ID) of the media to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.description
This endpoint allows you to update an AutoDJ media.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.parameters[].description
The unique identifier (ID) of the media to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.requestBody.content.application/json.schema.properties.albums.description
Specify the list of the albums of the song

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.requestBody.content.application/json.schema.properties.artists.description
Specify the list of the artists of the song

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.requestBody.content.application/json.schema.properties.genres.description
Specify the list of the genres of the song

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.delete.description
This endpoint allows you to delete an AutoDJ media.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.delete.parameters[].description
The unique identifier (ID) of the media to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/medias.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.summary
This endpoint allows you to list AutoDJ playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.description
*
* @api-summary       List AutoDJ Playlist
* @api_operation     ListAutoDJPlaylist

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.post.description
This endpoint allows you to store an AutoDJ playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.description
This endpoint allows you to retrieve an AutoDJ playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.parameters[].description
The unique identifier (ID) of the playlist to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.description
This endpoint allows you to update an AutoDJ playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.parameters[].description
The unique identifier (ID) of the playlist to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.delete.description
This endpoint allows you to delete an AutoDJ playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.delete.parameters[].description
The unique identifier (ID) of the playlist to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.summary
This endpoint allows you to list AutoDJ medias in playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.description
*
* @api-summary       List AutoDJ Medias Playlist
* @api_operation     ListAutoDJMediasPlaylist

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.parameters[].description
The unique identifier (ID) of the playlist to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/notification.get.description
This endpoint allows you to retrieve the notification bind to the radio_product or station if it's exist.

# paths./1/radios/{radio_product_id}/notification.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/notification.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/notification.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/notification.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/notification.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/notification.put.description
This endpoint allows you to update a notification for radio product.

# paths./1/radios/{radio_product_id}/notification.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.end_hour.description
Specify the last hour of the day to receive notification

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_friday.description
Specify if the notification can be sent the friday

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_mail.description
Specify if the notification will be sent by mail

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_monday.description
Specify if the notification can be sent the monday

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_saturday.description
Specify if the notification can be sent the saturday

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_sms.description
Specify if the notification will be sent by sms

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_sunday.description
Specify if the notification can be sent the sunday

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_thursday.description
Specify if the notification can be sent the thursday

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_tuesday.description
Specify if the notification can be sent the tuesday

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.is_wednesday.description
Specify if the notification can be sent the wednesday

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.start_hour.description
Specify the begin hour of the day to receive notification

# paths./1/radios/{radio_product_id}/notification.put.requestBody.content.application/json.schema.properties.users.description
Specify the list of account id will receive the notification

# paths./1/radios/{radio_product_id}/notification.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/notification.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/notification.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/notification.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/notification.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/notification.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players.get.description
This endpoint allows you to retrieve all the players in a product.

# paths./1/radios/{radio_product_id}/players.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/radios/{radio_product_id}/players.get.parameters[].schema.items.description
The player typesuperplayer_extended,1: Superplayer_extended superplayer,2: Superplayer big,3: Big medium,4: Medium small,5: Small

# paths./1/radios/{radio_product_id}/players.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/{radio_product_id}/players.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/players.post.description
This endpoint allows you to store a player.

# paths./1/radios/{radio_product_id}/players.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.background_color.description
Specify the background color used in the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.button_color.description
Specify the button color used in the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.display_name.description
Specify the name uses to display in the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.domains.description
Specify the domains allow accessing to the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.facebook_link.description
Specify the Facebook link used in Facebook embed

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.height.description
Specify the height in px for display the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.history_display.description
Specify the history display used in the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.history_hold.description
Specify if the maximum number of song displayed in history

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_embed.description
Specify if the embed url will be displayed int the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_facebook_embed.description
Specify if the Facebook embed url will be displayed int the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_history_clickable.description
Specify if the history could be clickable in history

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_history_time_display.description
Specify if the time will be displayed in history

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_hls_buffered.description
Specify if the player start at the beginning and buffer hls streams

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_listeners.description
Specify if listeners information is displayed

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_logo.description
Specify if the logo Infomaniak is displayed

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_metadata_display.description
Specify if the metadata title and artist will be visible

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_spectrum.description
Specify if the spectrum will be displayed

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_station_thumbnail.description
Specify if the station thumbnail will be displayed

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.is_twitter_embed.description
Specify if the Twitter embed url will be displayed int the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.listeners_hold.description
Specify listeners hold for listeners information

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.name.description
Specify the name of the player, it is not used in the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.secondary_color.description
Specify the secondary color used in the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.stations.items.properties.is_main.description
Specify if the station is the main station to listen

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.stations.items.properties.order.description
Specify the order of the station in the list

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.stations.items.properties.streams.items.properties.is_main.description
Specify if the stream is the main stream of the station

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.stations.items.properties.streams.description
Specify the list of streams used in the super player by station

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.stations.items.properties.hls_stream.properties.id.description
Specify the HLS Stream id used in the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.stations.items.properties.hls_stream.properties.is_main.description
Specify if the HLS stream is the main stream of this station

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.stations.description
Specify the list of stations used in the super player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.twitter_account.description
Specify the Twitter account will be used in Twitter embed

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.twitter_backlink.description
Specify the Twitter backlink used in Twitter embed

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.twitter_hashtag.description
Specify the Twitter hashtag used in Twitter embed

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.volume.description
Specify the default volume in the player

# paths./1/radios/{radio_product_id}/players.post.requestBody.content.application/json.schema.properties.width.description
Specify the width in px for display the player

# paths./1/radios/{radio_product_id}/players.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}.get.description
This endpoint allows you to retrieve a player.

# paths./1/radios/{radio_product_id}/players/{player_id}.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players/{player_id}.get.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/radios/{radio_product_id}/players/{player_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players/{player_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players/{player_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}.put.description
This endpoint allows you to update a player.

# paths./1/radios/{radio_product_id}/players/{player_id}.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players/{player_id}.put.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.background_color.description
Specify the background color used in the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.button_color.description
Specify the button color used in the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.display_name.description
Specify the name uses to display in the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.domains.description
Specify the domains allow accessing to the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.facebook_link.description
Specify the Facebook link used in Facebook embed

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.height.description
Specify the height in px for display the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.history_display.description
Specify the history display used in the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.history_hold.description
Specify if the maximum number of song displayed in history

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_embed.description
Specify if the embed url will be displayed int the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_facebook_embed.description
Specify if the Facebook embed url will be displayed int the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_history_clickable.description
Specify if the history could be clickable in history

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_history_time_display.description
Specify if the time will be displayed in history

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_hls_buffered.description
Specify if the player start at the beginning and buffer hls streams

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_listeners.description
Specify if listeners information is displayed

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_logo.description
Specify if the logo Infomaniak is displayed

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_metadata_display.description
Specify if the metadata title and artist will be visible

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_spectrum.description
Specify if the spectrum will be displayed

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_station_thumbnail.description
Specify if the station thumbnail will be displayed

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.is_twitter_embed.description
Specify if the Twitter embed url will be displayed int the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.listeners_hold.description
Specify listeners hold for listeners information

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.name.description
Specify the name of the player, it is not used in the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.secondary_color.description
Specify the secondary color used in the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.stations.items.properties.is_main.description
Specify if the station is the main station to listen

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.stations.items.properties.order.description
Specify the order of the station in the list

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.stations.items.properties.streams.items.properties.is_main.description
Specify if the stream is the main stream of the station

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.stations.items.properties.streams.description
Specify the list of streams used in the super player by station

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.stations.items.properties.hls_stream.properties.id.description
Specify the HLS Stream id used in the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.stations.items.properties.hls_stream.properties.is_main.description
Specify if the HLS stream is the main stream of this station

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.stations.description
Specify the list of stations used in the super player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.twitter_account.description
Specify the Twitter account will be used in Twitter embed

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.twitter_backlink.description
Specify the Twitter backlink used in Twitter embed

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.twitter_hashtag.description
Specify the Twitter hashtag used in Twitter embed

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.volume.description
Specify the default volume in the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.requestBody.content.application/json.schema.properties.width.description
Specify the width in px for display the player

# paths./1/radios/{radio_product_id}/players/{player_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players/{player_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players/{player_id}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/players/{player_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/players/{player_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.description
This endpoint allows you to delete a player.

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/players/{player_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/listeners.get.description
This endpoint allows you to retrieve product listeners stats.

# paths./1/radios/{radio_product_id}/stats/listeners.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/listeners.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stats/listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute.get.description
This endpoint allows you to retrieve product listeners stats per minute.

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute_grouped.get.description
This endpoint allows you to retrieve product listeners stats per minuteh.

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute_grouped.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute_grouped.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute_grouped.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/listeners_per_minute_grouped.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/countries.get.description
This endpoint allows you to retrieve product countries stats.

# paths./1/radios/{radio_product_id}/stats/countries.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/countries.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/countries.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/countries.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/countries_continent.get.description
This endpoint allows you to retrieve product total countries stats by continent.

# paths./1/radios/{radio_product_id}/stats/countries_continent.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/countries_continent.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/countries_continent.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/countries_continent.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/station_listeners.get.description
This endpoint allows you to retrieve product listeners stats by station.

# paths./1/radios/{radio_product_id}/stats/station_listeners.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/station_listeners.get.parameters[].schema.description
Define if station without listener are in the return

# paths./1/radios/{radio_product_id}/stats/station_listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/station_listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/station_listeners.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/consumption.get.description
This endpoint allows you to retrieve product consumption stats.

# paths./1/radios/{radio_product_id}/stats/consumption.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/total_consumption.get.description
This endpoint allows you to retrieve product total consumption stats.

# paths./1/radios/{radio_product_id}/stats/total_consumption.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/total_consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/total_consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/total_consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/station_consumption.get.description
This endpoint allows you to retrieve product consumption stats by station.

# paths./1/radios/{radio_product_id}/stats/station_consumption.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/station_consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/station_consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/station_consumption.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/players.get.description
This endpoint allows you to retrieve players stats.

# paths./1/radios/{radio_product_id}/stats/players.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/players.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/total_players.get.description
This endpoint allows you to retrieve total players stats.

# paths./1/radios/{radio_product_id}/stats/total_players.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/total_players.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/total_players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/total_players.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/stats_by_station.get.description
This endpoint allows you to retrieve stats group by stations.

# paths./1/radios/{radio_product_id}/stats/stats_by_station.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/stats_by_station.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/stats_by_station.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/stats_by_station.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/export_csv.get.description
This endpoint allows you to export product stats.

# paths./1/radios/{radio_product_id}/stats/export_csv.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/export_csv.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stats/export_csv.get.parameters[].schema.description
Specify the timezone for the output date

# paths./1/radios/{radio_product_id}/stats/export_csv.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/export_csv.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/export_csv.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stats/export_csv_by_station.get.description
This endpoint allows you to export product stats by station.

# paths./1/radios/{radio_product_id}/stats/export_csv_by_station.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stats/export_csv_by_station.get.parameters[].schema.description
Specifies the time period over which to aggregate and retrieve stats

# paths./1/radios/{radio_product_id}/stats/export_csv_by_station.get.parameters[].schema.description
Specify the timezone for the output date

# paths./1/radios/{radio_product_id}/stats/export_csv_by_station.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stats/export_csv_by_station.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stats/export_csv_by_station.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/mediapulse/report.get.summary
Generate a report for export mediapulse log with stations in product

# paths./1/radios/{radio_product_id}/options.get.description
This endpoint allows you to retrieve all the option attach to a radio product.

# paths./1/radios/{radio_product_id}/options.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/options.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/options.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/options.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/players/ip-access.post.description
This endpoint allows you to check ip access to mountpoint.

# paths./1/radios/players/ip-access.post.requestBody.content.application/json.schema.properties.mountpoint.description
Specify the mountpoint to check ip authorization

# paths./1/radios/players/ip-access.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/players/ip-access.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/players/ip-access.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/players/{player_uuid}/domain-access.post.description
This endpoint allows you to check domain access for player.

# paths./1/radios/players/{player_uuid}/domain-access.post.parameters[].description
The universally unique identifier (UUID) of the player to request.

# paths./1/radios/players/{player_uuid}/domain-access.post.requestBody.content.application/json.schema.properties.domain.description
Specify the domain to check authorization

# paths./1/radios/players/{player_uuid}/domain-access.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/players/{player_uuid}/domain-access.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/players/{player_uuid}/domain-access.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/streams/available-mountpoint.post.description
This endpoint allows you to check if a stream mountpoint is available.

# paths./1/radios/streams/available-mountpoint.post.requestBody.content.application/json.schema.properties.mountpoint.description
Specify the mountpoint to check the availability

# paths./1/radios/{radio_product_id}/restrictions.post.summary
Set the restrictions to all streams in product

# paths./1/radios/{radio_product_id}/restrictions.post.requestBody.content.application/json.schema.properties.country_list.description
Specify the country list not allow accessing to the stream

# paths./1/radios/{radio_product_id}/restrictions.post.requestBody.content.application/json.schema.properties.ip_exclude_list.description
Specify the ip list not allow accessing to the stream

# paths./1/radios/{radio_product_id}/restrictions.post.requestBody.content.application/json.schema.properties.ip_include_list.description
Specify the ip list allow accessing to the stream

# paths./1/radios/{radio_product_id}/restrictions.post.requestBody.content.application/json.schema.properties.is_allow_country.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/restrictions.post.requestBody.content.application/json.schema.properties.is_hash_restriction.description
Specify if the access restriction rules is enabled

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.post.description
This endpoint allows you to update a station thumbnail.

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.post.requestBody.content.application/json.schema.properties.thumbnail.description
Specify the new thumbnail file for the station

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.delete.description
This endpoint allows you to delete a station thumbnail.

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/thumbnail.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.description
This endpoint allows you to reset general parameters.

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/reset_general.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/send_logs.post.requestBody.content.application/json.schema.properties.targets.description
Specify where the exportation must be done

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.description
This endpoint allows you to toggle direct live.

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/toggle_direct.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.description
This endpoint allows you to force the disconnection of the main streams.

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/disconnect_st.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.description
This endpoint allows you to add a fallback stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the source stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.description
This endpoint allows you to remove the fallback stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the source stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.description
This endpoint allows you to toggle direct live.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/ad.post.description
This endpoint allows you to add a hls stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/ad.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/ad.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/ad.post.requestBody.content.application/json.schema.properties.buffer_size.description
Specify the buffer size of the hls stream

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/ad.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/ad.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/ad.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.description
This endpoint allows you to toggle direct live.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/hls_stream/to.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/a.post.description
This endpoint allows you to add transcoded stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/a.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/a.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/a.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/a.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/a.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.description
This endpoint allows you to unbind transcoding on transcoded stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.parameters[].description
The unique identifier (ID) of the transcoded stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/restar.post.description
This endpoint allows you to restart AutoDJ.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/restar.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/restar.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/restar.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/restar.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/restar.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.requestBody.content.application/json.schema.properties.force.description
Specify if we force the generation and overwrite

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.description
This endpoint allows you to insert vod media after another one in the playing playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.requestBody.content.application/json.schema.properties.playing_media_id.description
Specify the playing media id to put before or after

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.requestBody.content.application/json.schema.properties.position.description
Specify the position before or after playing media id to add

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.description
This endpoint allows you to move radio media after another one in the playing playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.requestBody.content.application/json.schema.properties.playing_media_id.description
Specify the playing media id to put before or after

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.requestBody.content.application/json.schema.properties.position.description
Specify the position before or after playing media id to add

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}/duplicate.post.description
This endpoint allows you to duplicate a player.

# paths./1/radios/{radio_product_id}/players/{player_id}/duplicate.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players/{player_id}/duplicate.post.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/radios/{radio_product_id}/players/{player_id}/duplicate.post.requestBody.content.application/json.schema.properties.name.description
Specify the name of the player, it is not used in the player

# paths./1/radios/{radio_product_id}/players/{player_id}/duplicate.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players/{player_id}/duplicate.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players/{player_id}/duplicate.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.description
This endpoint allows you to reset a player.

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/players/{player_id}/reset.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.description
This endpoint allows you to update a thumbnail.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.requestBody.content.application/json.schema.properties.thumbnail.description
Specify the new thumbnail file for the player

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.requestBody.content.application/json.schema.properties.type.description
Specify the type of thumbnail will be changed

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.description
This endpoint allows you to delete a thumbnail.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.parameters[].description
The unique identifier (ID) of the player to request.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.parameters[].schema.description
Specify the type of thumbnail will be changed

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/players/{player_id}/thumbnail.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.description
This endpoint allows you to delete a stream and convert transcoding stream to standard stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].description
The unique identifier (ID) of the stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].schema.description
Specify the stream id that will be unbind

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.parameters[].schema.description
Specify the user password to check authorization

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}/streams/{stre.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.description
This endpoint allows you to delete transcoding.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.description
This endpoint allows you to remove transcoded stream.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.parameters[].description
The unique identifier (ID) of the transcoded stream to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}/transcoding/{.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.description
This endpoint allows you to remove media from playing playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playin.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.description
This endpoint allows you to update an AutoDJ playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.parameters[].description
The unique identifier (ID) of the playlist to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/playli.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds.get.description
List all public clouds for the given account

# paths./1/public_clouds.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/public_clouds.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/public_clouds.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/public_clouds.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/public_clouds.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/accesses.get.description
Return a list of access by Service for a given account and if maintenance ongoing

# paths./1/public_clouds/accesses.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/public_clouds/kaas.get.description
List all Kubernetes Services for all Public Clouds

# paths./1/public_clouds/kaas.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/kaas.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/public_clouds/kaas.get.parameters[].schema.description
A valid Public Cloud Identifier to filter the list by

# paths./1/public_clouds/kaas.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/public_clouds/kaas.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/public_clouds/kaas.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/kaas.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/public_clouds/kaas.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/public_clouds/kaas.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/kaas.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/public_clouds/kaas.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/public_clouds/kaas.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/kaas.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/public_clouds/kaas.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/kaas/packs.get.description
List all Kubernetes Service Packs for the current client

# paths./1/public_clouds/kaas/versions.get.description
List all possible Kubernetes Service Versions

# paths./1/public_clouds/kaas/regions.get.description
List all possible Kubernetes Service Regions

# paths./1/public_clouds/kaas/availability_zones.get.description
List all possible Kubernetes Service Availability Zones for the given Region

# paths./1/public_clouds/kaas/availability_zones.get.parameters[].schema.description
List all Availability Zones for the given Public Cloud Region

# paths./1/public_clouds/dbaas.get.description
List all Database Services for all public clouds in the given account

# paths./1/public_clouds/dbaas.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/dbaas.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/public_clouds/dbaas.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/public_clouds/dbaas.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/public_clouds/dbaas.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/dbaas.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/public_clouds/dbaas.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/public_clouds/dbaas.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/dbaas.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/dbaas/regions.get.description
List all possible regions to use when creating a Database Service

# paths./1/public_clouds/dbaas/packs.get.description
List all available Database Service packs

# paths./1/public_clouds/dbaas/packs.get.parameters[].schema.properties.maximum_instances.description
Filter by number of instances, maximum value

# paths./1/public_clouds/dbaas/packs.get.parameters[].schema.properties.maximum_rate.properties.excluding_tax.description
Filter by maximum rate (lte, including tax)

# paths./1/public_clouds/dbaas/packs.get.parameters[].schema.properties.maximum_rate.properties.including_tax.description
Filter by maximum rate (lte, including tax)

# paths./1/public_clouds/dbaas/packs.get.parameters[].schema.properties.maximum_storage.description
Filter by amount of Storage, maximum value

# paths./1/public_clouds/dbaas/packs.get.parameters[].schema.properties.minimum_rate.properties.excluding_tax.description
Filter by minimum rate (gte, excluding tax)

# paths./1/public_clouds/dbaas/packs.get.parameters[].schema.properties.minimum_rate.properties.including_tax.description
Filter by minimum rate (gte, including tax)

# paths./1/public_clouds/dbaas/packs/filters.get.description
List all filters that can be used when filtering packs

# paths./1/public_clouds/dbaas/types.get.description
List all available Database Service types

# paths./1/public_clouds/dbaas/configurations.get.description
Return configuration information including object storage rates and possible parameters

# paths./1/public_clouds/projects.get.description
List all public cloud projects for all public clouds

# paths./1/public_clouds/projects.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/projects.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/public_clouds/projects.get.parameters[].schema.description
A valid Public Cloud Identifier to filter the list by

# paths./1/public_clouds/projects.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/public_clouds/projects.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/public_clouds/projects.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/projects.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/public_clouds/projects.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/public_clouds/projects.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/projects.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/public_clouds/projects.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/public_clouds/projects.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/projects.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/public_clouds/projects.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/config.get.description
Get configuration information for the given account

# paths./1/public_clouds/config.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/public_clouds/{public_cloud_id}.get.parameters[].description
Unique identifier of the Public Cloud product

# paths./1/public_clouds/{public_cloud_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/{public_cloud_id}.patch.parameters[].description
Unique identifier of the Public Cloud product

# paths./1/public_clouds/{public_cloud_id}/projects.get.description
List all public cloud projects of the given public cloud

# paths./1/public_clouds/{public_cloud_id}/projects.get.parameters[].description
Unique identifier of the Public Cloud product

# paths./1/public_clouds/{public_cloud_id}/projects.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/{public_cloud_id}/projects.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/public_clouds/{public_cloud_id}/projects.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/public_clouds/{public_cloud_id}/projects.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/{public_cloud_id}/projects.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/public_clouds/{public_cloud_id}/projects.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/{public_cloud_id}/projects.post.description
Create a new public cloud project with user

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Get the given public cloud project details

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.description
Delete the given public cloud project and it's users (the project can be restored during 7 days)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all public cloud users for the given public cloud project

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Create a new public cloud user for the given public cloud project

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Get the authentication file for the given public cloud user

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Get the authentication file for the given public cloud user

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all instances of Kubernetes Service in the given project

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Create a new instance of Kubernetes Service

Returns the unique identifier of the newly created Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all possible Kubernetes Service flavors for the given account

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.properties.maximum_rate.properties.excluding_tax.description
Filter by maximum rate (lte, including tax)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.properties.maximum_rate.properties.including_tax.description
Filter by maximum rate (lte, including tax)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.properties.maximum_storage.description
Filter by amount of Storage, maximum value

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.properties.minimum_rate.properties.excluding_tax.description
Filter by minimum rate (gte, excluding tax)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.properties.minimum_rate.properties.including_tax.description
Filter by minimum rate (gte, including tax)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.description
Public Cloud region to use for your KaaS

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List filters for Kubernetes Service flavors for the given account

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.description
Public Cloud region to use for your KaaS

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Return an instance of Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.description
Delete an instance of Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.description
Modify an instance of Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.requestBody.content.application/json.schema.properties.kubernetes_version.description
Upgrade version. This will start a rolling update of the given Kubernetes Service. Only 1 minor version can be updated at a time. The version can never be downgraded

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.summary
Get the current state of a Kaas apiserver params

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.summary
Patch apiserver params of a specific Kaas

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Download the KaaS Administration Kubernetes Service Configuration

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all Instance Pools for the given Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Create a new Instance Pool for the given Kubernetes Service

Returns the unique identifier of the newly created Instance Pool

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.flavor.description
Instance Pool Flavor, possible flavors

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.labels.description
Array of valid Kubernetes labels to apply to the instances. The label must have a prefix of node-role.kubernetes.io or belong to the domains node-restriction.kubernetes.io or custom.kaas.infomaniak.cloud. For more information about label formats, see: Label Information

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.maximum_instances.description
Maximum number of instances. If maximum_instances is greater than minimum_instances, autoscaling will be enabled

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.prefix.description
Prefix to use with when naming instances

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.rollout_after.description
Date after which all machines in this pool may receive a rollout, and get restarted as a result (RFC3339 format, e.g. 2026-09-09T09:00:00Z)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.400.description
Cannot create worker pool not enough available nodes

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.enum[]
Cannot create worker pool not enough available nodes

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Cannot create worker pool not enough available nodes

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.400.content.application/json.examples.Cannot create worker pool not enough available nodes.value.error.description
Cannot create worker pool not enough available nodes

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Return an Instance Pool from the given Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.description
Delete an Instance Pool from the given Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.description
Modify an Instance Pool from the given Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.requestBody.content.application/json.schema.properties.labels.description
Array of valid Kubernetes labels to apply to the instances. The label must have a prefix of node-role.kubernetes.io or belong to the domains node-restriction.kubernetes.io or custom.kaas.infomaniak.cloud. For more information about label formats, see: Label Information

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.requestBody.content.application/json.schema.properties.maximum_instances.description
Maximum number of instances. If maximum_instances is greater than minimum_instances, autoscaling will be enabled

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.requestBody.content.application/json.schema.properties.rollout_after.description
Date after which all machines in this pool may receive a rollout, and get restarted as a result (RFC3339 format, e.g. 2026-09-09T09:00:00Z), or null to remove the scheduled date.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.responses.400.description
Cannot update worker pool not enough available nodes

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.enum[]
Cannot update worker pool not enough available nodes

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Cannot update worker pool not enough available nodes

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.responses.400.content.application/json.examples.Cannot update worker pool not enough available nodes.value.error.description
Cannot update worker pool not enough available nodes

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all IP filters for given Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.put.description
Add/Update the list of IP filters for the given Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.put.requestBody.content.application/json.schema.properties.ip_filters.items.description
A valid CIDR to use when filtering access to the given Database Service (whitelist)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.put.requestBody.content.application/json.schema.properties.ip_filters.description
List of whitelist IP filters to apply to the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.description
Remove all IP filters from the given Kubernetes Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all Database Services for the given public cloud project

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Create a new Database Service for the given public cloud project

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.backup_schedule.properties.add_default_schedule.description
Add the default backup schedule to the Database Service. The default schedule is ran during a random hour:minute once a day keeping 7 days worth of backups.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.backup_schedule.properties.retention.description
The number of backups to keep for the schedule

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.backup_schedule.properties.scheduled_at.description
Use the given time as the time to create the scheduled backup (24 hour, UTC)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.parameters[].schema.description
Should the database backup files be kept and not deleted

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all backups for given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Get the current information for the given Database Service backup

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.description
Delete the given Database Service backup

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all backup schedules for given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.retention.description
The number of backups to keep for the schedule

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.scheduled_at.description
Use the given time as the time to create the scheduled backup (24 hour, UTC)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Get the Backup Schedule for given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.description
Delete the backup schedule from the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.requestBody.content.application/json.schema.properties.retention.description
The number of backups to keep for the schedule

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.patch.requestBody.content.application/json.schema.properties.scheduled_at.description
Use the given time as the time to create the scheduled backup (24 hour, UTC)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Get the current information for the given Database Service restore

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List the configuration for given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.put.description
Add/Update the configuration for the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.description
Remove the configuration from the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all IP filters for given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.put.description
Add/Update the list of IP filters for the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.put.requestBody.content.application/json.schema.properties.ip_filters.items.description
A valid CIDR to use when filtering access to the given Database Service (whitelist)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.put.requestBody.content.application/json.schema.properties.ip_filters.description
List of whitelist IP filters to apply to the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.delete.description
Remove all IP filters from the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
List all Database Service logs for the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.description
Get logs from this date [format: timestamp]

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.description
Get logs to this date [format: timestamp]

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.description
Download all logs for the given Database Service and period.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.description
Get logs from this date [format: timestamp]

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.get.parameters[].schema.description
Get logs to this date [format: timestamp]

# paths./1/public_clouds/{public_cloud_id}/projects/invite.post.description
Create a new public cloud project with a user invitation

# paths./1/public_clouds/{public_cloud_id}/projects/invite.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/public_clouds/{public_cloud_id}/projects/invite.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/public_clouds/{public_cloud_id}/projects/invite.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/{public_cloud_id}/projects/invite.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/public_clouds/{public_cloud_id}/projects/invite.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/public_clouds/{public_cloud_id}/projects/invite.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Create a new public cloud user invitation for the given public cloud project

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Update the given public cloud user and sent an invitation to reset the user's password

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Reset the root password and send it and other connection information to use for logging into the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Turn on/off slow logs for the given Database Service

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.description
Create a new restore for the given Database Service using the given backup

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.new_service.properties.backup_schedule.properties.add_default_schedule.description
Add the default backup schedule to the Database Service. The default schedule is ran during a random hour:minute once a day keeping 7 days worth of backups.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.new_service.properties.backup_schedule.properties.retention.description
The number of backups to keep for the schedule

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.new_service.properties.backup_schedule.properties.scheduled_at.description
Use the given time as the time to create the scheduled backup (24 hour, UTC)

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.new_service.description
Create a new Database Service and restore the backed up data. Use this object to specify service options.

# paths./1/public_clouds/{public_cloud_id}/projects/{public_cloud_projec.post.requestBody.content.application/json.schema.properties.pitr_restore_date.description
Point in time recovery date in ISO 3339 format

# paths./1/mail_hostings/{mail_hosting_id}/bimi.post.description
Create or update (if you already have one) the bimi associated to the mail service

# paths./1/mail_hostings/{mail_hosting_id}/bimi.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/bimi.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/bimi.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates.get.description
List all signatures templates for the given Mail Hosting product

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates.post.description
Create a new signatures templates for the given Mail Hosting product

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates.post.requestBody.content.application/json.schema.properties.mail_hosting_id.description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/upload.post.description
Upload an image to prepare for insertion in the template

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/upload.post.requestBody.content.application/json.schema.properties.image.description
Base64 image content (png,jpg,jpeg,svg or gif MIME type)

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/upload.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/upload.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_create_object: Triggered when the entity cannot be created.

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/upload.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/{signatu.post.description
Create a signature for all the users of the mail service conformed to the template specified

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/{signatu.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/{signatu.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/{signatu.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.get.description
Returns list of auto replies models for given service mail

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.description
Create new auto reply for given service mail

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.requestBody.content.application/json.schema.properties.dont_reply_to.description
List of emails the auto reply won't respond to

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.requestBody.content.application/json.schema.properties.ended_at.description
When should end the auto reply activation

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.requestBody.content.application/json.schema.properties.is_recurrent.description
Define if the responder should be activate for some days in the week instead of a certain time

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.requestBody.content.application/json.schema.properties.is_visible.description
Define if the attributes is visible for all the users

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.requestBody.content.application/json.schema.properties.recurrent_days.description
List of the days when the auto reply is activated

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/filters.get.description
Returns the list of filter model for the given Service Mail
List all the filter for the specified mail service

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.get.description
This endpoint allows you to retrieve all the mailboxes for a given mail hosting.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.post.description
Creates a new mailbox in the mail hosting.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes.post.requestBody.content.application/json.schema.properties.target.description
Specifies who has access to the mailbox during its creation.current_user: Only the current user has access to the mailbox. ksuite_user: All users who are part of the kSuite product can access the mailbox. other_user: All invited users can have access to the mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.description
Returns a variety of information about one or more Mailing list subscribers from a Unique identifier of the Hosting Mail to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.description
Add a new list member for the specified mailing list

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.delete.description
Remove a subscriber from a Mailing list identified by his email

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.description
Update the email of an existing subscriber identified by his previous email adress

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.requestBody.content.application/json.schema.properties.email.description
The email that identifies the subscriber.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.requestBody.content.application/json.schema.properties.new_email.description
The new email for the specified subscriber.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.description
Add a list of subscriber to the specified mailing list by specifying the fullname and the email for each subscribers

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.requestBody.content.application/json.schema.properties.datas.description
One email address per line, formatted like this: email address, name

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.get.description
Returns all the mailing list that are owned by the given email service
<note>Please note that this may respond a 200 response with swap attributes if the main domain of the mail service is swapping</note>

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.description
Creates a new mailing list with for the current mail service with the specified parameters

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.requestBody.content.application/json.schema.properties.is_reply_to_forced.description
Tells if the mail of the sender is replaced by the mailing list mail

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.requestBody.content.application/json.schema.properties.lang.description
Current language preference code.de: German language. en: English language. es: Spanish language. fr: French language. it: Italian language.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.requestBody.content.application/json.schema.properties.should_send_notifications.description
Tells if the mailing list should send or not welcome/goodbye message

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.requestBody.content.application/json.schema.properties.use_reply_to.description
Tells if the expeditor's mail is substitute by the mailing list email when responding to it

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.requestBody.content.application/json.schema.properties.who_can_send.description
Indicates who can send mails in the mailing list.0: Only moderator and subscriber can send email through the mailing list. 1: Only moderator can send email through the mailing list. 2: Everyone can send email through the mailing list but requires a moderator validation. 3: Only moderator and subscriber can send email through the mailing list but requires a moderator validation. 4: Everyone can send a mail through the mailing list but requires a moderator validation for the mail sent by non subscribers.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.requestBody.content.application/json.schema.properties.who_can_subscribe.description
The subscription policy setup for the mailing list.0: Anybody can subscribe. 1: Any new subscription should be confirmed by the owner. 2: Any new subscription should be confirmed by the owner and the subscriber.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.description
Enable or disable the filter of a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.requestBody.content.application/json.schema.properties.is_enabled.description
Specify if the filter is enabled or disabled

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.description
Reorder the filters of a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.description
Retrieve the sieve filters of a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.description
Add a filter to the given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.requestBody.content.application/json.schema.properties.has_all_of.description
Indicates if all the condition are needed or if just one is sufficient

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.description
Delete a filter from the given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.description
Update the filter of a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.requestBody.content.application/json.schema.properties.has_all_of.description
Indicates if all the condition are needed or if just one is sufficient

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.description
Add a sieve script to a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.requestBody.content.application/json.schema.properties.content.example
if header :contains "Subject" "Urgent" {stop;}

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.requestBody.content.application/json.schema.properties.is_enabled.description
Specify if the script is enabled or disabled

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_create_object: Triggered when the entity cannot be created.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.description
Delete a sieve script from the given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.description
Update a sieve script for a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.requestBody.content.application/json.schema.properties.content.example
if header :contains "Subject" "Urgent" {stop;}

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.requestBody.content.application/json.schema.properties.is_enabled.description
Specify if the script is enabled or disabled

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.description
Enable / disable a filter script for a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.description
Retrieves the folders of a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.description
Updates the folder mapping configuration for the draft, trash, sent an spam folders of a given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.requestBody.content.application/json.schema.properties.commercials_folder.description
The location where the referenced commercial mail goes. Required if the option is activated on the mailbox

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.requestBody.content.application/json.schema.properties.social_networks_folder.description
The location where the referenced social mails are placed. Required if the option is activated on the mailbox

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.requestBody.content.application/json.schema.properties.spam_folder.description
The location where all the spam labelled mail are stored.Required if the spam filter is activated on the mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.description
Set default signature for send and reply

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.description
List all signatures for the given Mailbox

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.description
Create a new signatures for the given MailHosting product

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.layout.properties.layout.description
Specifies the layout of the template.2-columns: Layout with two columns. column: Layout with one column. custom: Custom layout with custom html. default: Default layout. large-picture-and-text: Layout with a large picture and text. picture-and-text: Layout with a picture and text.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.media.properties.accountLogoUrlMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.media.properties.userAvatarUrlMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.departmentMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.hasDepartment.description
Indicates if the templates contains this attributes or not

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.hasJob.description
Indicates if the templates contains this attributes or not

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.hasMail.description
Indicates if the templates contains this attributes or not

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.jobMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.mailMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.nameFormatMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.phones.items.properties.type.description
Choose the icon associated with the phone number.mobile_icon: Mobile phone icon. mobile_letter: Mobile phone letter M. none: No icon. phone_icon: Phone icon. phone_letter: Phone letter T. phone_letter_alt: Fixed phone letter F.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.phones.description
List of phone numbers associated with the signature template.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.professional.properties.accountNameMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.professional.properties.addressMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.form_data.properties.professional.properties.urlMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.position.description
Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.bottom: The signature is placed at the bottom of the email. top: The signature is placed at the top of the email.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.description
Upload an image to prepare for insertion in the signature

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.requestBody.content.application/json.schema.properties.image.description
Base64 image content (png,jpg,jpeg,svg or gif MIME type)

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_create_object: Triggered when the entity cannot be created.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.get.description
Retrieves information about the forwarding configuration of a given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.requestBody.content.application/json.schema.properties.has_dont_deliver.description
Indicates if the mailbox should delete emails locally after forwarding them

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.requestBody.content.application/json.schema.properties.has_forward_spam.description
Indicates if the mailbox should forward mail that are considered to be spam

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.requestBody.content.application/json.schema.properties.is_enabled.description
Indicates if the redirection is enabled on the mailbox.\n Warning: setting it to false drop all the existing adresses

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.requestBody.content.application/json.schema.properties.redirect_addresses.description
List of the redirection addresses where the mail are redirected in the mailbox, the maximum is set to 1 if you have a starter pack

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.post.description
Adds a new forwarding address to the given mailbox

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.description
Deletes all configured forwarding addresses of the given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.description
Get auto replies models available for a given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.description
Create an auto replies model for a given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.requestBody.content.application/json.schema.properties.dont_reply_to.description
 List of mail that aren't concerned by the responder

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.requestBody.content.application/json.schema.properties.recurrent_days.description
List of the days when the auto reply is activated

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.requestBody.content.application/json.schema.properties.reply_from_id.description
Id of the Email that send the auto reply

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.requestBody.content.application/json.schema.properties.started_at.description
Dates when the responder has become active

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.description
Resets the count of automatic replies that were sent per sender.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.get.description
This endpoint allows you to retrieve all the aliases for a given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.description
Updates the list of aliases for a given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/redirections.get.description
Return redirections for the given mail service

# paths./1/mail_hostings/{mail_hosting_id}/redirections.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/redirections.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/redirections.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/redirections.post.description
Create a new redirection with the specified parameters for the current mail service

# paths./1/mail_hostings/{mail_hosting_id}/redirections.post.requestBody.content.application/json.schema.properties.name.description
The name of the redirection, where the emails should be sent.

# paths./1/mail_hostings/{mail_hosting_id}/redirections.post.requestBody.content.application/json.schema.properties.targets.description
Emails that should receive the mail that are redirected

# paths./1/mail_hostings/{mail_hosting_id}/redirections.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/redirections.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/redirections.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.get.description
This returns all targets email for the specified redirection

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.post.description
Add a new target email for the specified redirection

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.delete.description
Remove one target from the redirection list

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.description
Returns list of user accesses, team  accesses and invitations for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.description
Create a webmail access for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_already_has_access_to_mailbox: The user already has access to the mailbox.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_not_attached_to_account: The user is not attached to the account.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.description
Bulk Create webmail user accesses for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_already_has_access_to_mailbox: The user already has access to the mailbox.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_not_attached_to_account: The user is not attached to the account.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.description
Bulk Create webmail user accesses for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_already_has_access_to_mailbox: The user already has access to the mailbox.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_not_attached_to_account: The user is not attached to the account.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.description
Bulk Create webmail team accesses for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.team_already_has_access_to_mailbox: The team already has access to the mailbox.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.team_not_attached_to_account: The team is not attached to the account.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.description
Create a link to access the mailbox specified in the webmail

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.description
Send a link to access the mailbox specified in the webmail by e-mail

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.requestBody.content.application/json.schema.properties.language.description
Current language preference code.de: German language. en: English language. es: Spanish language. fr: French language. it: Italian language.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.429.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 429

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invitation_sending_rate_limit_reached: The invitation was already sent in the last minute.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.description
Returns list of device accesses for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].schema.description
Specifies the type of the device.computer: The device is a computer. legacy: The device'password is a legacy password used by all users before the feature of multiples password. other: The device is an other type. phone: The device is a phone. tablet: The device is a tablet.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.description
Create a device access for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.requestBody.content.application/json.schema.properties.device_uid.description
UID of the true device used by an access token

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.requestBody.content.application/json.schema.properties.protocols.description
Specifies the protocol of the access. By default, all protocol choices include smtp protocol.imap: The protocol is imap. pop3: The protocol is pop3. pop3-imap: The protocol is imap and pop3.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.requestBody.content.application/json.schema.properties.type.description
Specifies the type of the device.computer: The device is a computer. other: The device is an other type. phone: The device is a phone. tablet: The device is a tablet.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.device_already_has_access_to_mailbox: The device already has access to the mailbox.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.existing_device_can_only_have_one_user: The device can't give access to many users. legacy_device_creation: A legacy device can't have more accesses.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.description
Delete all device accesses on an address

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.description
Update the password of a device access for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.post.parameters[].description
The unique identifier (ID) of the device access to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the device access to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.get.description
Returns true or false if the user can rotate dkim

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dkim_dns_not_managed: DNS is not managed by Admin.

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.get.responses.424.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 424

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.get.responses.424.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dkim_cannot_fetch: Could not fetch DKIM.

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.get.responses.424.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.description
Rotates the dkim key for the current service mail without deleting old keys from dns

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dkim_dns_not_managed: DNS is not managed by Admin.

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.412.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 412

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.412.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dkim_cannot_rotate: Cannot rotate DKIM.

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.412.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.424.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 424

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.424.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dkim_cannot_fetch: Could not fetch DKIM.

# paths./1/mail_hostings/{service_mail}/diagnostic/dkim/rotate.post.responses.424.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}/set_pri.post.description
Set the primary mailbox for the authenticated user

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}/set_pri.post.parameters[].description
The unique identifier (ID) of the email address.

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}/set_pri.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}/set_pri.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_has_no_access_to_mailbox: The user has no access to the mailbox.

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}/set_pri.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/preferences.get.description
Returns preferences for given Service Mail

# paths./1/mail_hostings/{mail_hosting_id}/preferences.patch.description
Update preferences for given service Mail

# paths./1/mail_hostings/{mail_hosting_id}/preferences.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/preferences.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/preferences.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/preferences.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/preferences.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/preferences.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/default.get.description
Return the default signature template if there is one for the specified mail service

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/default.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/{signatu.get.description
Show details about the specified signature template

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/{signatu.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/signatures/templates/{signatu.put.requestBody.content.application/json.schema.properties.mail_hosting_id.description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.requestBody.content.application/json.schema.properties.dont_reply_to.description
List of emails the auto reply won't respond to

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.requestBody.content.application/json.schema.properties.ended_at.description
When should end the auto reply activation

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.requestBody.content.application/json.schema.properties.is_recurrent.description
Define if the responder should be activate for some days in the week instead of a certain time

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.requestBody.content.application/json.schema.properties.is_visible.description
Define if the attributes is visible for all the users

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.requestBody.content.application/json.schema.properties.recurrent_days.description
List of the days when the auto reply is activated

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/auto_replies/{auto_reply_id}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/filters/{filter_id}.get.description
Return the information from the specified filter model linked to the given mail service

# paths./1/mail_hostings/{mail_hosting_id}/filters/{filter_id}.get.parameters[].description
The identifier of the concerned mail service

# paths./1/mail_hostings/{mail_hosting_id}/filters/{filter_id}.put.description
Update filter model for given Service Mail

# paths./1/mail_hostings/{mail_hosting_id}/filters/{filter_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/filters/{filter_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/filters/{filter_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/filters/{filter_id}.delete.description
Delete  filters for given Service Mail


api_return boolean

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.description
Getting all the details from the specified mailing list

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.delete.description
Delete the specified mailing list from the current mail service

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.description
Update some information like welcome message, maximum size of message for the specified mailing list owned by the given mail service

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.requestBody.content.application/json.schema.properties.is_reply_to_forced.description
Tells if the mail of the sender is replaced by the mailing list mail

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.requestBody.content.application/json.schema.properties.lang.description
Current language preference code.de: German language. en: English language. es: Spanish language. fr: French language. it: Italian language.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.requestBody.content.application/json.schema.properties.should_send_notifications.description
Tells if the mailing list should send or not welcome/goodbye message

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.requestBody.content.application/json.schema.properties.use_reply_to.description
Tells if the expeditor's mail is substitute by the mailing list email when responding to it

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.requestBody.content.application/json.schema.properties.who_can_send.description
Indicates who can send mails in the mailing list.0: Only moderator and subscriber can send email through the mailing list. 1: Only moderator can send email through the mailing list. 2: Everyone can send email through the mailing list but requires a moderator validation. 3: Only moderator and subscriber can send email through the mailing list but requires a moderator validation. 4: Everyone can send a mail through the mailing list but requires a moderator validation for the mail sent by non subscribers.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.requestBody.content.application/json.schema.properties.who_can_subscribe.description
The subscription policy setup for the mailing list.0: Anybody can subscribe. 1: Any new subscription should be confirmed by the owner. 2: Any new subscription should be confirmed by the owner and the subscriber.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.get.description
Returns a variety of information about a single a Mailbox specified by the requested unique identifier.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.get.parameters[].schema.description
Specifies the storage unit for the mailbox.b: Return the unit size in Bytes. mb: Return the unit size in Megabytes. kb: Return the unit size in Kilobytes.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.description
Return the information of the specified signature template

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The unique identifier of the signature template.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.description
Show the specified signature from the current mailbox

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.get.parameters[].description
The unique identifier (ID) of the signature to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.delete.parameters[].description
The unique identifier (ID) of the signature to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.parameters[].description
The unique identifier (ID) of the signature to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.layout.properties.layout.description
Specifies the layout of the template.2-columns: Layout with two columns. column: Layout with one column. custom: Custom layout with custom html. default: Default layout. large-picture-and-text: Layout with a large picture and text. picture-and-text: Layout with a picture and text.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.media.properties.accountLogoUrlMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.media.properties.userAvatarUrlMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.departmentMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.hasDepartment.description
Indicates if the templates contains this attributes or not

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.hasJob.description
Indicates if the templates contains this attributes or not

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.hasMail.description
Indicates if the templates contains this attributes or not

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.jobMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.mailMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.nameFormatMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.static: The value is predefined in the model and remains constant. user: The values of the attributes must be provided by the user during the template creation process.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.phones.items.properties.type.description
Choose the icon associated with the phone number.mobile_icon: Mobile phone icon. mobile_letter: Mobile phone letter M. none: No icon. phone_icon: Phone icon. phone_letter: Phone letter T. phone_letter_alt: Fixed phone letter F.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.personal.properties.phones.description
List of phone numbers associated with the signature template.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.professional.properties.accountNameMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.professional.properties.addressMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.form_data.properties.professional.properties.urlMode.description
Specifies the mode for injecting attribute values into the signature template when it is used by a user. The mode determines how the attribute values are provided or derived.auto: The value of the attributes is automatically derived from the user's information. static: The value is predefined in the model and remains constant.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.requestBody.content.application/json.schema.properties.position.description
Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.bottom: The signature is placed at the bottom of the email. top: The signature is placed at the top of the email.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/sign.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.description
Show an auto replies model for a given mailbox

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.delete.description
Delete an auto replies model for a given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.description
Update an auto replies model for a given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.requestBody.content.application/json.schema.properties.dont_reply_to.description
 List of mail that aren't concerned by the responder

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.requestBody.content.application/json.schema.properties.recurrent_days.description
List of the days when the auto reply is activated

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.requestBody.content.application/json.schema.properties.reply_from_id.description
Id of the Email that send the auto reply

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.requestBody.content.application/json.schema.properties.started_at.description
Dates when the responder has become active

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auto.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.get.description
Return details about the specified redirections for the given mail service

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.put.description
Update the specified redirection's details

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.delete.description
Delete a redirection from the mail service

# paths./1/mail_hostings/{service_mail}/accounts.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox}/email_import.get.description
Returns list of email imports for the mailbox specified for the current user

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox}/email_import.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox}/email_import.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox}/email_import.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.description
Returns list of users for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.description
Get all team accesses related to a user for a mailbox

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the user to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.description
Get all user accesses related to a team for a mailbox

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the team to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.description
Returns list of device accesses for the mailbox specified for a user

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
The unique identifier (ID) of the user to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.description
Delete device accesses for the mailbox specified for a user

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the user to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/accesses/devices/users/{user_id}.get.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/accesses/devices/users/{user_id}.get.parameters[].description
The unique identifier (ID) of the user to request.

# paths./1/mail_hostings/{service_mail}/accesses/devices/users/{user_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/{service_mail}/accesses/devices/users/{user_id}.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/accesses/webmail.get.description
Returns list of accesses for the current user

# paths./1/mail_hostings/accesses/webmail.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/accesses/webmail.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/users/{u.get.summary
List of accesses for an account and a user

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/users/{u.get.description
Returns list of accesses for an account and a user

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/users/{u.get.parameters[].description
The unique identifier (ID) of the account to request.

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/users/{u.get.parameters[].description
The unique identifier (ID) of the user to request.

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/users/{u.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/users/{u.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/teams/{t.get.description
Returns list of team accesses for a team

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/teams/{t.get.parameters[].description
The unique identifier (ID) of the account to request.

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/teams/{t.get.parameters[].description
The unique identifier (ID) of the user to request.

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/teams/{t.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/accesses/webmail/accounts/{account_id}/teams/{t.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/accesses/devices.get.description
Returns list of device and all their access

# paths./1/mail_hostings/accesses/devices.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/mail_hostings/accesses/devices.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/accesses/devices.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/accesses/devices.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/accesses/devices.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/mail_hostings.get.description
Returns a variety of information about one or more Hosting Mail from an Account identifier.

# paths./2/mail_hostings.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/mail_hostings.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./2/mail_hostings.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.put.description
Send the specified message to all the adress of the mailing list

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.put.requestBody.content.application/json.schema.properties.from.description
The email from where the mail is sent to the concerned mailing list

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.put.description
Generate a form concerning a mailing list for handling subscription or unsubscription

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.put.requestBody.content.application/json.schema.properties.url_after_subscription.description
Redirection link that can be applied after subscription

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.put.requestBody.content.application/json.schema.properties.url_after_unsubscription.description
Redirection link that can be applied after unsubscription

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailing_lists/{mailing_list_n.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.description
Deletes an invitation from a given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.patch.description
Updates the permissions of a given invitation on a mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.patch.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.patch.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/invi.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.put.description
This routes enables you to send a mail of confirmation for the redirection specified

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.put.description
Resends the confirmation email to the specified target

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/mail_hostings/{mail_hosting_id}/redirections/{redirection_id}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.description
Delete a webmail access for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the user to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_cannot_remove_team_access: The user can't remove team access on a mailbox.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_has_no_access_to_mailbox: The user has no access to the mailbox.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.description
Update a webmail access for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.parameters[].description
The unique identifier (ID) of the user to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.description
Delete a team webmail access for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.parameters[].description
The unique identifier (ID) of the team to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.description
Update a webmail access for the mailbox specified

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.parameters[].description
The unique identifier (ID) of the team to request.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/{service_mail}/mailboxes/{mailbox_name}/accesse.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/accesses/devices/{device}.delete.parameters[].description
The unique identifier (ID) of the device to request.

# paths./1/mail_hostings/accesses/devices/{device}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/accesses/devices/{device}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/accesses/devices/{device}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/accesses/devices/{device}.patch.parameters[].description
The unique identifier (ID) of the device to request.

# paths./1/mail_hostings/accesses/devices/{device}.patch.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/mail_hostings/accesses/devices/{device}.patch.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.device_already_exists: The device with the same name already exists.

# paths./1/mail_hostings/accesses/devices/{device}.patch.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/accesses/devices/{device}.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/accesses/devices/{device}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/mail_hostings/accesses/devices/{device}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.description
Deletes all mails currently in the spam folder of the given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.description
Deletes all mails currently in the trash folder of the given mailbox linked to the current user

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/auth.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.description
Deletes the given forwarding address from the given mailbox.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/forw.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.delete.parameters[].description
The unique identifier (ID) of the mail hosting to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.delete.parameters[].description
The username (that is the part before the @) of the email address you want to request.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/{mail_hosting_id}/mailboxes/{mailbox_name}/alia.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.summary
Delete access to a mailbox for the current user

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.description
Delete access to a mailbox for the current user

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_cannot_remove_team_access: The user can't remove team access on a mailbox.

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.user_has_no_access_to_mailbox: The user has no access to the mailbox.

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/mail_hostings/accesses/webmail/mailboxes/{mailbox_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/etickets/address.get.description
This endpoint allows you to retrieve all address of a group

# paths./2/etickets/address.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/address.get.parameters[].schema.properties.id.description
Unique identifier of the resource `{name}`

# paths./2/etickets/address.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/etickets/customers/{customer_id}/logs.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/date.get.description
This endpoint allows you to retrieve all dates of a period

# paths./2/etickets/date.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/dates/custom-properties.get.description
This endpoint allows you to retrieve all date custom properties

Custom properties are key-value pairs that can be associated with dates to store additional information.
They can be used to filter, sort, and group dates based on their values.

# paths./2/etickets/dates/custom-properties.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/metaproducts.get.description
This endpoint allows you to retrieve all the metaproducts.

# paths./2/etickets/metaproducts/variants.get.description
This endpoint allows you to retrieve all metaproduct variants.

# paths./2/etickets/reservation/{reservation_id}.get.description
This endpoint allows you to retrieve a reservation of a period allowed for user

# paths./2/etickets/reservation/{reservation_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/reservation/{reservation_uuid}.get.description
This endpoint allows you to retrieve a reservation of a period allowed for user

# paths./2/etickets/reservation/{reservation_uuid}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/surveys.get.description
This endpoint allows you to retrieve surveys

# paths./2/etickets/surveys.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/surveys/answers/tickets.get.description
This endpoint allows you to retrieve ticket survey answers

# paths./2/etickets/surveys/answers/tickets.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/surveys/answers/tickets.patch.description
This endpoint allows you to create update or empty ticket survey answers

# paths./2/etickets/surveys/answers/tickets.patch.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/surveys/answers/passes.get.description
This endpoint allows you to retrieve pass survey answers

# paths./2/etickets/surveys/answers/passes.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/surveys/answers/passes.patch.description
This endpoint allows you to create update or empty pass survey answers

# paths./2/etickets/surveys/answers/passes.patch.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/etickets/ticket.patch.description
This endpoint allow you to edit ticket information

# paths./2/etickets/ticket.patch.requestBody.content.application/json.schema.properties.tickets.items.properties.id.description
Unique identifier of the resource `{name}`

# paths./2/domains/domains.get.parameters[].schema.description
Filter domains expiring after this timestamp

# paths./2/domains/domains.get.parameters[].schema.description
Filter domains expiring before this timestamp

# paths./2/domains/domains.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/domains/domains/{domain}/nameservers.put.requestBody.content.application/json.schema.properties.nameservers.description
Required without use_infomaniak_ns parameter. Array of nameservers to use for the domain

# paths./2/domains/domains/{domain}/nameservers.put.requestBody.content.application/json.schema.properties.use_infomaniak_ns.description
Required without nameservers parameter. Use Infomaniak nameservers for the domain

# paths./2/domains/domains/{domain}/nameservers.put.requestBody.content.application/json.schema.properties.verify_ns_availability.description
Verify ensure that the new nameservers are functional before making any changes. Default: false

# paths./2/domains/domains/{domain}/nameservers.put.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/domains/{domain}/nameservers.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.nameservers_update_failed: Triggered when the nameservers update fails.

# paths./2/domains/domains/{domain}/nameservers.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/domains/{domain}/zones.get.description
List all Zones (base zone and delegated zones)

# paths./2/domains/domains/{domain}/zones.get.parameters[].schema.description
Specify what to return. Use "total" to return only the total count of zones

# paths./2/domains/domains/{domain}/zones.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/domains/domains/{domain}/dnssec/check.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/domains/domains/{domain}/dnssec/check.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dnssec_management_failed: Triggered when a DNSSEC operation fails.

# paths./2/domains/domains/{domain}/dnssec/check.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/domains/{domain}/dnssec/enable.post.requestBody.content.application/json.schema.properties.dnssec_data.items.description
Only necessary when domain has external nameservers. DSData or KeyData that will be sent to the registry

# paths./2/domains/domains/{domain}/dnssec/enable.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/domains/domains/{domain}/dnssec/enable.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dnssec_management_failed: Triggered when a DNSSEC operation fails.

# paths./2/domains/domains/{domain}/dnssec/enable.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/domains/{domain}/dnssec/disable.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/domains/domains/{domain}/dnssec/disable.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dnssec_management_failed: Triggered when a DNSSEC operation fails.

# paths./2/domains/domains/{domain}/dnssec/disable.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/{domain}/nameservers.put.requestBody.content.application/json.schema.properties.nameservers.description
Required without use_infomaniak_ns parameter. Array of nameservers to use for the domain

# paths./2/domains/{domain}/nameservers.put.requestBody.content.application/json.schema.properties.use_infomaniak_ns.description
Required without nameservers parameter. Use Infomaniak nameservers for the domain

# paths./2/domains/{domain}/nameservers.put.requestBody.content.application/json.schema.properties.verify_ns_availability.description
Verify ensure that the new nameservers are functional before making any changes. Default: false

# paths./2/domains/{domain}/nameservers.put.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/{domain}/nameservers.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.nameservers_update_failed: Triggered when the nameservers update fails.

# paths./2/domains/{domain}/nameservers.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/{domain}/zones.get.description
List all Zones (base zone and delegated zones)

# paths./2/domains/{domain}/zones.get.parameters[].schema.description
Specify what to return. Use "total" to return only the total count of zones

# paths./2/domains/{domain}/zones.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/domains/{domain}/dnssec/check.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/domains/{domain}/dnssec/check.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dnssec_management_failed: Triggered when a DNSSEC operation fails.

# paths./2/domains/{domain}/dnssec/check.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/{domain}/dnssec/enable.post.requestBody.content.application/json.schema.properties.dnssec_data.items.description
Only necessary when domain has external nameservers. DSData or KeyData that will be sent to the registry

# paths./2/domains/{domain}/dnssec/enable.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/domains/{domain}/dnssec/enable.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dnssec_management_failed: Triggered when a DNSSEC operation fails.

# paths./2/domains/{domain}/dnssec/enable.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/{domain}/dnssec/disable.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/domains/{domain}/dnssec/disable.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.dnssec_management_failed: Triggered when a DNSSEC operation fails.

# paths./2/domains/{domain}/dnssec/disable.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/check.post.requestBody.content.application/json.schema.properties.with_option_prices.description
Should return the options price (Fast Anycast, Domain Privacy), default: false

# paths./2/domains/accounts/{account}/check.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/accounts/{account}/check.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.subdomain_availability_check_fail: Triggered when trying to check availability of a subdomain.

# paths./2/domains/accounts/{account}/check.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/check.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/domains/accounts/{account}/check.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_tld: Triggered when the tld doesn't exist or not available for sale.

# paths./2/domains/accounts/{account}/check.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/domains/accounts/{account}/contacts.get.parameters[].schema.description
Filter contacts associated with a specific domain

# paths./2/domains/accounts/{account}/contacts.post.requestBody.content.application/json.schema.properties.country_code.description
Country code of the contact (ISO 3166-1 alpha-2)

# paths./2/domains/accounts/{account}/contacts/{contact}.put.description
Update a Contact

A validation may be required. If so, a validation email will be sent
and the update will need to be confirmed via the email link.
Otherwise, the Contact is updated immediately.

# paths./2/domains/accounts/{account}/contacts/{contact}.put.requestBody.content.application/json.schema.properties.country_code.description
Country code of the contact (ISO 3166-1 alpha-2)

# paths./2/domains/accounts/{account}/contacts/{contact}.put.requestBody.content.application/json.schema.properties.email.description
Email of the contact (only accepted if current email address is set to [email@not.valid])

# paths./2/domains/accounts/{account}/contacts/{contact}.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/domains/accounts/{account}/contacts/{contact}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/domains/accounts/{account}/contacts/{contact}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts/{contact}.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/domains/accounts/{account}/contacts/{contact}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/domains/accounts/{account}/contacts/{contact}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts/emails/verifications.post.summary
Create Email Contact Verification Request

# paths./2/domains/accounts/{account}/contacts/emails/verifications.post.description
Create an email contact verification request

# paths./2/domains/accounts/{account}/contacts/emails/verifications.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/accounts/{account}/contacts/emails/verifications.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.bad_request: Triggered when the request is not well build.

# paths./2/domains/accounts/{account}/contacts/emails/verifications.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts/emails/verifications.post.responses.429.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 429

# paths./2/domains/accounts/{account}/contacts/emails/verifications.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_requests: Triggered when the user made too many requests.

# paths./2/domains/accounts/{account}/contacts/emails/verifications.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.summary
Resend Email Contact Verification Request

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.description
Resend an email contact verification request from uuid

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.bad_request: Triggered when the request is not well build.

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.429.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 429

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_requests: Triggered when the user made too many requests.

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.summary
Verify Email Contact Verification Request

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.description
Verify an email contact verification request with a token

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.bad_request: Triggered when the request is not well build.

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/domains/accounts/{account}/contacts/emails/verifications/{uui.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/create.post.description
Create a Domain using prepaid payment (documentation: https://developer.infomaniak.com/docs/api/order/domain/how)

# paths./2/domains/accounts/{account}/create.post.requestBody.content.application/json.schema.properties.additional_fields.items.description
An additional field required for the tld

# paths./2/domains/accounts/{account}/create.post.requestBody.content.application/json.schema.properties.additional_fields.description
All the additional fields required for the tld

# paths./2/domains/accounts/{account}/create.post.requestBody.content.application/json.schema.properties.address.description
The debitor address id, if not specified will use the account's default address

# paths./2/domains/accounts/{account}/create.post.requestBody.content.application/json.schema.properties.amount_total_excl_tax.description
Amount expected from the client, if calculated price is not equal, request will fail

# paths./2/domains/accounts/{account}/create.post.requestBody.content.application/json.schema.properties.with_options.properties.dns_anycast.description
Enable the renewal warranty option (default: false)

# paths./2/domains/accounts/{account}/create.post.requestBody.content.application/json.schema.properties.with_options.properties.domain_privacy.description
Enable the domain privacy option (default: false)

# paths./2/domains/accounts/{account}/create.post.requestBody.content.application/json.schema.properties.with_options.properties.renewal_warranty.description
Enable the renewal warranty option (default: false)

# paths./2/domains/accounts/{account}/create.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/accounts/{account}/create.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_domain_action: Triggered when the domain status does not allow the action. invalid_tld_registration_period: Triggered when the desired registration period is not available for the specified tld. invalid_expected_amount: Triggered when an expected amount doesnt match the calculated order amount. not_enough_funds_prepaid_balance: Triggered when the amount exceeds the prepaid account balance. payment_profile_in_maintenance: Triggered when the payment profile is in maintenance. payment_profile_not_set: Triggered when the payment profile is not set. invalid_contact_field: Triggered when a domain contact field is invalid. invalid_additional_field: Triggered when at least one domain additional field is invalid. invalid_options_field: Triggered when form domain options fields is invalid. error_creating_domain_services: Triggered when there's an error during the creation of the domain services.

# paths./2/domains/accounts/{account}/create.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/create/{domain}.post.description
Retry a failed Domain creation, with updated Contact and additional fields

# paths./2/domains/accounts/{account}/create/{domain}.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/accounts/{account}/create/{domain}.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_contact_field: Triggered when a domain contact field is invalid. invalid_additional_field: Triggered when at least one domain additional field is invalid.

# paths./2/domains/accounts/{account}/create/{domain}.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/create/{domain}.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/domains/accounts/{account}/create/{domain}.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.failed_order_not_found: Triggered when the failed order for the specified domain is not found.

# paths./2/domains/accounts/{account}/create/{domain}.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/transfer.post.description
Transfer a domain using prepaid payment (documentation: https://developer.infomaniak.com/docs/api/order/domain/how)

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.additional_fields.items.description
An additional field required for the tld

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.additional_fields.description
All the additional fields required for the tld

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.address.description
The debitor address id, if not specified will use the account's default address

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.amount_total_excl_tax.description
Amount expected from the client, if calculated price is not equal, request will fail

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.nameserver_choice.description
Specifies which nameservers to use after domain transfer. 
                [keep] Preserves the current nameservers currently assigned to the domain (default),
                [infomaniak] Uses Infomaniak’s default nameservers,
                [custom] Allows you to set your own nameservers.

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.nameservers.description
Required if nameserver_choice parameter is custom. Array of nameservers to use for the domain

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.with_options.properties.dns_anycast.description
Enable the renewal warranty option (default: false)

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.with_options.properties.domain_privacy.description
Enable the domain privacy option (default: false)

# paths./2/domains/accounts/{account}/transfer.post.requestBody.content.application/json.schema.properties.with_options.properties.renewal_warranty.description
Enable the renewal warranty option (default: false)

# paths./2/domains/accounts/{account}/transfer.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/accounts/{account}/transfer.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_domain_action: Triggered when the domain status does not allow the action. invalid_expected_amount: Triggered when an expected amount doesnt match the calculated order amount. not_enough_funds_prepaid_balance: Triggered when the amount exceeds the prepaid account balance. payment_profile_in_maintenance: Triggered when the payment profile is in maintenance. payment_profile_not_set: Triggered when the payment profile is not set. invalid_contact_field: Triggered when a domain contact field is invalid. invalid_additional_field: Triggered when at least one domain additional field is invalid. invalid_options_field: Triggered when form domain options fields is invalid. error_creating_domain_services: Triggered when there's an error during the creation of the domain services.

# paths./2/domains/accounts/{account}/transfer.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/transfer/{domain}.post.description
Retry a failed domain transfer, with updated contact and additional fields

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_contact_field: Triggered when a domain contact field is invalid. invalid_additional_field: Triggered when at least one domain additional field is invalid.

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.failed_order_not_found: Triggered when the failed order for the specified domain is not found.

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.429.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 429

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_failed_transfer_attempts: Triggered when failing to transfer a domain too many times.

# paths./2/domains/accounts/{account}/transfer/{domain}.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/documents.get.description
List all account's domain related documents

# paths./2/domains/accounts/{account}/documents.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/domains/accounts/{account}/documents.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_document: Triggered when the provided document could not be stored.

# paths./2/domains/accounts/{account}/documents.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/domains/accounts/{account}/documents/{document_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/domains/accounts/{account}/documents/{document_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/domains/accounts/{account}/documents/{document_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/domains/accounts/{account}/documents/{document_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/tld.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/tld/{tld}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/zones/{zone}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/zones/{zone}.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible. zone_does_not_exists: Triggered when the server try to retrieve a zone that does not exist.

# paths./2/zones/{zone}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/zones/{zone}.put.requestBody.content.application/json.schema.properties.skel.description
A skel file to use for zone update. SOA and infomaniak ns records will be ignored.

# paths./2/zones/{zone}.put.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/zones/{zone}.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.missing_required_record_type: Triggered when the server try to add or update a zone but there is some required records that are missing.

# paths./2/zones/{zone}.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible. zone_does_not_exists: Triggered when the server try to retrieve a zone that does not exist.

# paths./2/zones/{zone}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/zones/{zone}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./2/zones/{zone}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.post.description
Store a zone<br/>
⚠️ You do not need to add a delegated subzone if it is delegated on the same server. We recommended adding dns records directly to the parent zone.

# paths./2/zones/{zone}.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/zones/{zone}.post.requestBody.content.application/json.schema.properties.skel.description
A skel file to use for zone creation. SOA and infomaniak ns records will be ignored.

# paths./2/zones/{zone}.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/zones/{zone}.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.zone_already_exists: Triggered when the server try to create an already existing zone. missing_required_record_type: Triggered when the server try to add or update a zone but there is some required records that are missing.

# paths./2/zones/{zone}.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/zones/{zone}.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/zones/{zone}.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_create_object: Triggered when the entity cannot be created.

# paths./2/zones/{zone}.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible. zone_does_not_exists: Triggered when the server try to retrieve a zone that does not exist.

# paths./2/zones/{zone}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/zones/{zone}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./2/zones/{zone}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/exists.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}/exists.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}/exists.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/exists.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}/exists.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/zones/{zone}/exists.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records.get.description
Retrieve all dns record for a given zone

# paths./2/zones/{zone}/records.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/zones/{zone}/records.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}/records.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}/records.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}/records.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/zones/{zone}/records.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/zones/{zone}/records.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/zones/{zone}/records.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/zones/{zone}/records.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_dns_record: Triggered when the server try to parse an invalid dns record type. dns_record_mutual_exclusion: Triggered when the server try to add a dns record but there is a mutual exclusion with another dns record on same sub domain. unsupported_dns_record_type: Triggered when the server try to parse an unsupported dns record type. dns_record_already_exists: Triggered when the server try to create an already existing dns record.

# paths./2/zones/{zone}/records.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}/records.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}/records.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}/records.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.zone_does_not_exists: Triggered when the server try to retrieve a zone that does not exist. object_not_found: Triggered when the asked entity is not accessible.

# paths./2/zones/{zone}/records.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/zones/{zone}/records.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_create_object: Triggered when the entity cannot be created.

# paths./2/zones/{zone}/records.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.get.description
Retrieve one dns record for a given zone

# paths./2/zones/{zone}/records/{record}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/zones/{zone}/records/{record}.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}/records/{record}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}/records/{record}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}/records/{record}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/zones/{zone}/records/{record}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/zones/{zone}/records/{record}.put.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/zones/{zone}/records/{record}.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_dns_record: Triggered when the server try to parse an invalid dns record type. dns_record_mutual_exclusion: Triggered when the server try to add a dns record but there is a mutual exclusion with another dns record on same sub domain.

# paths./2/zones/{zone}/records/{record}.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}/records/{record}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}/records/{record}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}/records/{record}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.zone_does_not_exists: Triggered when the server try to retrieve a zone that does not exist. object_not_found: Triggered when the asked entity is not accessible.

# paths./2/zones/{zone}/records/{record}.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/zones/{zone}/records/{record}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./2/zones/{zone}/records/{record}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}/records/{record}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}/records/{record}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}/records/{record}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.zone_does_not_exists: Triggered when the server try to retrieve a zone that does not exist. object_not_found: Triggered when the asked entity is not accessible.

# paths./2/zones/{zone}/records/{record}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/zones/{zone}/records/{record}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./2/zones/{zone}/records/{record}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}/check.get.description
Verify that the given dns record exists and resolve on name servers master and it's slave

# paths./2/zones/{zone}/records/{record}/check.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/zones/{zone}/records/{record}/check.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.zone_not_managed_by_infomaniak_dns: Triggered when an action cannot be done because the zone is not managed by Infomaniak DNS.

# paths./2/zones/{zone}/records/{record}/check.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}/check.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/zones/{zone}/records/{record}/check.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/zones/{zone}/records/{record}/check.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/zones/{zone}/records/{record}/check.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/zones/{zone}/records/{record}/check.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/zones/{zone}/records/{record}/check.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.tags[]
User Management > Accounts > Invitations > Drive

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.description
This API endpoint allows you to create an access to the specified drive, for an invitation of a user in an account.

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_user_quota_reached: Triggered when the quota storage of the drive is reached. product_is_part_of_ksuite: Triggered when product is part of ksuite.

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_already_exists: Triggered when the entity already exists.

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/accounts/{account}/invitations/{invitation}/drive.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.tags[]
User Management > Accounts > Invitations > kSuite

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.description
This API endpoint allows you to create access to the kSuite for an invitation of a user in an account.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.ksuite_drive_quota_reached: Triggered when the quota of the drive attached to the ksuite is reached. drive_user_quota_reached: Triggered when the quota storage of the drive is reached. ksuite_quota_reached: Triggered when the quota storage of the ksuite is reached.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.ksuite_not_found_for_account: Triggered when the account don't have a kSuite.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.signature_mailbox_id: Triggered when the given mailbox signature is invalid.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.tags[]
User Management > Accounts > Invitations > kSuite

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.description
This API endpoint allows you to revoke a access to the kSuite for an invitation of a user in an account.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.product_is_part_of_ksuite: Triggered when product is part of ksuite.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.ksuite_not_found_for_account: Triggered when the account don't have a kSuite. object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_already_exists: Triggered when the entity already exists.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/accounts/{account}/invitations/{invitation}/ksuite.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/invite.post.tags[]
User Management > Accounts > Invitations > Mailbox

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.post.tags[]
User Management > Accounts > Invitations > Mailbox

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.mailboxes_quota_reached: Triggered when the quota storage of the mailboxes is reached.

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_already_exists: Triggered when the entity already exists.

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.tags[]
User Management > Accounts > Invitations > Mailbox

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.description
This API endpoint allows you to revoke access to the specified drive, for an invitation of a user in an account

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_already_exists: Triggered when the entity already exists.

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.patch.tags[]
User Management > Accounts > Invitations > Mailbox

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.patch.description
This API endpoint allows you to update an email access, for an invitation of a user in an account.

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations/{invitation}/mailbox/{mail_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/b2b.get.tags[]
User Management > Accounts > Invitations > B2B

# paths./1/accounts/{account}/invitations/{invitation}/b2b.get.description
This API endpoint allows you to list all futures customers allowed for this account invitation

# paths./1/accounts/{account}/invitations/{invitation}/b2b.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account}/invitations/{invitation}/b2b.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/accounts/{account}/invitations/{invitation}/b2b.post.tags[]
User Management > Accounts > Invitations > B2B

# paths./1/accounts/{account}/invitations/{invitation}/b2b.post.description
This API endpoint allows you to store customers for a user invitation of a partner account

# paths./1/accounts/{account}/invitations/{invitation}/b2b.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/invitations/{invitation}/b2b.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.account_not_partner: Access denied, the account does not have the required partner role for this resource.

# paths./1/accounts/{account}/invitations/{invitation}/b2b.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/b2b.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}/b2b.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations/{invitation}/b2b.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/tags.post.description
Store a new tag (not linked to any product)

# paths./1/accounts/{account}/teams.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account}/teams.get.parameters[].schema.properties.owned_by_ids.description
Array of user IDs who are owners of the team

# paths./1/accounts/{account}/teams.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/teams.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/teams.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/teams.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/teams.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/teams.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/teams.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/accounts/{account}/teams.post.requestBody.content.application/json.schema.properties.app_accesses.properties.drive.properties.folders.items.properties.id.description
Unique identifier of the resource `{name}`

# paths./1/accounts/{account}/teams.post.requestBody.content.application/json.schema.properties.app_accesses.properties.kchat.properties.channels.items.properties.id.description
Unique identifier of the resource `{name}`

# paths./1/accounts/{account}/teams.post.requestBody.content.application/json.schema.properties.owned_by_id.description
Unique identifier of the user that owned the resource Team

# paths./1/accounts/{account}/teams.post.requestBody.content.application/json.schema.properties.owned_by_ids.description
Array of user IDs who are owners of the team

# paths./1/accounts/{account}/teams.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/teams.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/teams.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/teams.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/teams.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/teams.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/teams.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/teams.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_create_object: Triggered when the entity cannot be created.

# paths./1/accounts/{account}/teams.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/teams/{team}/users.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/teams/{team}/users.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/teams/{team}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/teams/{team}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/teams/{team}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/teams/{team}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/accounts/{account}/teams/{team}/users.post.description
Add one or more existing Account Users to a given Team.

# paths./1/accounts/{account}/teams/{team}/users.post.requestBody.content.application/json.schema.properties.user_ids.description
The user identifiers to add to the team.

# paths./1/accounts/{account}/teams/{team}/users.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/teams/{team}/users.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/teams/{team}/users.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/teams/{team}/users.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/teams/{team}/users.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/teams/{team}/users.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/teams/{team}/users.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.delete.description
Remove one or more existing Users from a given Team.

# paths./1/accounts/{account}/teams/{team}/users.delete.parameters[].schema.description
The user identifiers to add to the team.

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/accounts/{account}/teams/{team}/users.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations.post.description
Create and send an invitation for a new or existing User to join an Account using an email address.

# paths./1/accounts/{account}/invitations.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.email.description
The email address of the user being invited.

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.first_name.description
The first name of the user being invited.

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.last_name.description
The last name of the user being invited.

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.locale.description
The locale code for the language of the invitation the user will receive.

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.notifications.properties.billing.description
Whether or not the user will be able to receive billing notifications. (default: `false`)

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.notifications.properties.products.description
Whether or not the user will be able to receive product notifications. (default: `false`)

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.notifications.description
Notifications configuration for the user.

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.permissions.properties.billing.description
Whether or not the user will be able to manage the billing account. (default: `false`)

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.role_type.description
The role to assign to the user upon invitation.

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.silent.description
Whether or not the user will receive the invitation email. (default: `false`)

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.strict.description
Whether or not the user should register with the same email address. (default: `true`)

# paths./1/accounts/{account}/invitations.post.requestBody.content.application/json.schema.properties.teams.description
The teams the user should be added to upon invitation.

# paths./1/accounts/{account}/invitations.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/invitations.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/invitations.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/invitations.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/invitations.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/my_ksuite/{my_k_suite_id}/cancel_unsubscribe.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/my_ksuite/{my_k_suite_id}/cancel_unsubscribe.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/my_ksuite/{my_k_suite_id}/cancel_unsubscribe.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/avatar.post.description
Image must be a scared image with minimum size of 16 of type image/png, image/jpeg or image/gif

# paths./2/profile/avatar.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/avatar.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/avatar.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/avatar.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/avatar.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/avatar.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/avatar.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/profile/avatar.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./2/profile/avatar.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/avatar.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/avatar.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./2/profile/avatar.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/avatar.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/avatar.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/avatar.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/avatar.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/avatar.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/avatar.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/avatar.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/avatar.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./2/profile/avatar.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/applications/passwords.get.description
This endpoint allows you to retrieve all the application password of the current user.

# paths./2/profile/applications/passwords.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/applications/passwords.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/applications/passwords.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/applications/passwords.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/applications/passwords.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/applications/passwords.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/applications/passwords.post.description
Add a profile specific password
Warning: password given in response cannot be retrieved later, so store / show it immediately

# paths./2/profile/applications/passwords.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/applications/passwords.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_create_object: Triggered when the entity cannot be created.

# paths./2/profile/applications/passwords.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/ksuites/mailboxes.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/ksuites/mailboxes.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/ksuites/mailboxes.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/ksuites/mailboxes.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/ksuites/mailboxes.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./2/profile/ksuites/mailboxes.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}.get.tags[]
User Management > Accounts > Invitations

# paths./1/accounts/{account}/invitations/{invitation}.get.description
Returns a variety of information about an invitation to an account

# paths./1/accounts/{account}/invitations/{invitation}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account}/invitations/{invitation}.delete.description
Cancel an invitation to join an Account previously created.

# paths./1/accounts/{account}/invitations/{invitation}.delete.parameters[].description
Unique identifier of the User Invitation

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/accounts/{account}/invitations/{invitation}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}.patch.tags[]
User Management > Accounts > Invitations

# paths./1/accounts/{account}/invitations/{invitation}.patch.description
Update roles, teams and permissions of an invitation

# paths./1/accounts/{account}/invitations/{invitation}.patch.requestBody.content.application/json.schema.properties.language_id.description
Unique identifier of the `language` that is related to the resource `{name}`

# paths./1/accounts/{account}/invitations/{invitation}.patch.requestBody.content.application/json.schema.properties.permissions.items.properties.product_id.description
Unique identifier of the `product` that is related to the resource `{name}`

# paths./1/accounts/{account}/invitations/{invitation}.patch.requestBody.content.application/json.schema.properties.permissions.items.properties.service_id.description
Unique identifier of the `service` that is related to the resource `{name}`

# paths./1/accounts/{account}/invitations/users/{user}.get.tags[]
User Management > Accounts > Invitations

# paths./1/accounts/{account}/invitations/users/{user}.get.description
Show list of all invitations of a user into an account

# paths./1/accounts.get.description
This endpoint allows you to retrieve all the accounts of a user.

# paths./1/accounts.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}.get.description
Returns a variety of information about a single Account specified by the requested unique identifier.

# paths./1/accounts/{account_id}.get.parameters[].description
Unique identifier of the Account to request.

# paths./1/accounts/{account_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}/tags.get.summary
Display a listing of tags for an account.

# paths./1/accounts/{account_id}/tags.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account_id}/tags.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account_id}/tags.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/accounts/{account_id}/tags.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}/products.get.parameters[].description
Unique identifier of the Account to request.

# paths./1/accounts/{account_id}/products.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account_id}/products.get.parameters[].schema.properties.service_id.description
Unique identifier of the `service` that is related to the resource `{name}`

# paths./1/accounts/{account_id}/products.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account_id}/products.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account_id}/products.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}/products.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account_id}/products.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account_id}/products.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}/products.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account_id}/products.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/accounts/{account_id}/products.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}/services.get.description
This endpoint allows you to retrieve all the services of an account.

# paths./1/accounts/{account_id}/services.get.parameters[].description
Unique identifier of the Account to request.

# paths./1/accounts/{account_id}/services.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account_id}/services.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account_id}/services.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}/services.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account_id}/services.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account_id}/services.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account}/teams/{team}.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/teams/{team}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/teams/{team}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/teams/{team}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/teams/{team}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/teams/{team}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/teams/{team}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/teams/{team}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/teams/{team}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/teams/{team}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/teams/{team}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/teams/{team}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/teams/{team}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/teams/{team}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/accounts/{account}/teams/{team}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.patch.requestBody.content.application/json.schema.properties.owned_by_id.description
Unique identifier of the user that owned the resource Team

# paths./1/accounts/{account}/teams/{team}.patch.requestBody.content.application/json.schema.properties.owned_by_ids.description
Array of user IDs who are owners of the team

# paths./1/accounts/{account}/teams/{team}.patch.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account}/teams/{team}.patch.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account}/teams/{team}.patch.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.patch.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/teams/{team}.patch.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./1/accounts/{account}/teams/{team}.patch.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/teams/{team}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/teams/{team}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/teams/{team}.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/teams/{team}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/accounts/{account}/teams/{team}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/current/products.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/current/products.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/current/products.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/current/products.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/current/products.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/current/products.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/current/products.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/current/products.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/current/products.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/accounts/current/products.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}/basic/teams.get.summary
List basic teams information of an account.

# paths./1/accounts/{account_id}/basic/teams.get.parameters[].description
Unique identifier of the Account to request.

# paths./1/accounts/{account_id}/basic/teams.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/accounts/{account_id}/basic/teams.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/accounts/{account_id}/basic/teams.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/accounts/{account_id}/basic/teams.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account_id}/basic/teams.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account_id}/basic/teams.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account_id}/basic/teams.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/actions/{action_id}.get.parameters[].description
The unique identifier (ID) of the action to request.

# paths./1/actions/{action_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/actions/{action_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/actions/{action_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/app-information/versions/{appStore}/{appPlatform}/{appName}.get.summary
Get application with associated versions details.

# paths./1/app-information/versions/{appStore}/{appPlatform}/{appName}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/app-information/versions/{appStore}/{appPlatform}/{appName}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/app-information/versions/{appStore}/{appPlatform}/{appName}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/async/tasks.get.description
This endpoint allows you to retrieve all the tasks.

# paths./1/async/tasks.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/async/tasks.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/async/tasks/{task_uuid}.get.description
Returns a variety of information about a single Task specified by the requested unique identifier.

# paths./1/async/tasks/{task_uuid}.get.parameters[].description
The unique identifier (UUID) of the task to request.

# paths./1/countries.get.description
This endpoint allows you to retrieve all the countries.

# paths./1/countries.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/countries.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/countries/{country_id}.get.description
Returns a variety of information about a single Country specified by the requested unique identifier.

# paths./1/countries/{country_id}.get.parameters[].description
The unique identifier (ID) of the country to request.

# paths./1/languages.get.description
This endpoint allows you to retrieve all the languages.

# paths./1/languages.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/languages.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/languages/{language_id}.get.description
Returns a variety of information about a single Language specified by the requested unique identifier.

# paths./1/languages/{language_id}.get.parameters[].description
The unique identifier (ID) of the language to request.

# paths./1/my_ksuite/{my_k_suite_id}.get.description
Returns a variety of information about my kSuite

# paths./1/my_ksuite/{my_k_suite_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/my_ksuite/{my_k_suite_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/my_ksuite/{my_k_suite_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/my_ksuite/{my_k_suite_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/my_ksuite/current.get.description
Load the my_ksuite product from the user permission.

# paths./1/my_ksuite/current.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/my_ksuite/current.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/my_ksuite/current.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/my_ksuite/current.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/my_ksuite/current.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/my_ksuite/current.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/my_ksuite/current.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/products.get.description
This endpoint allows you to retrieve all the products where the current user's has at least one right.

# paths./1/products.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./1/products.get.parameters[].schema.description
Unique identifier of the `account` that is related to the resource `{name}`

# paths./1/products.get.parameters[].schema.description
Unique identifier of the `product` that is related to the resource `{name}`

# paths./1/products.get.parameters[].schema.description
Unique identifier of the `service` that is related to the resource `{name}`

# paths./1/products.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./1/products.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./1/products.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/products.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/products.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/products.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/products.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/products.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./1/products.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/products.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/products.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/timezones.get.description
This endpoint allows you to retrieve all the timezones.

# paths./1/timezones.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/timezones.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/timezones/{timezone_id}.get.description
Returns a variety of information about a single Timezone specified by the requested unique identifier.

# paths./1/timezones/{timezone_id}.get.parameters[].description
The unique identifier (ID) of the timezone to request.

# paths./2/accounts/{account}/users.get.description
This endpoint allows you to retrieve all users of a single Account specified by the requested unique identifier.

# paths./2/accounts/{account}/users.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/accounts/{account}/users.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/accounts/{account}/users.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/accounts/{account}/users.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/accounts/{account}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/accounts/{account}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/accounts/{account}/users.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/accounts/{account}/users.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/accounts/{account}/users/{user}/app_accesses.get.description
This endpoint allows you to retrieve all user's application access in a single Account specified by the requested unique identifier.

# paths./2/accounts/{account}/users/{user}/app_accesses.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/accounts/{account}/users/{user}/app_accesses.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/accounts/{account}/users/{user}/app_accesses.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/accounts/{account}/users/{user}/app_accesses.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/accounts/{account}/users/{user}/app_accesses.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/accounts/{account}/users/{user}/app_accesses.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/events/public-cloud-status.get.description
This endpoint allow you to get Public Cloud status

# paths./2/events.get.description
This endpoint allows you to retrieve all the opened events.

# paths./2/events.get.parameters[].schema.description
Represents a language identifier and a region identifier

# paths./2/events/{event_id}.get.description
Returns a variety of information about a single Event specified by the requested unique identifier.

# paths./2/events/{event_id}.get.parameters[].description
The unique identifier (ID) of the event to request.

# paths./2/profile.get.description
This endpoint allows you to retrieve all the information of the current user.

# paths./2/profile.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/profile.patch.parameters[].schema.description
Ensures that the request passes the system validation

# paths./2/profile.patch.requestBody.content.application/json.schema.properties.language_id.description
Unique identifier of the `language` that is related to the resource `{name}`

# paths./2/profile.patch.requestBody.content.application/json.schema.properties.locale.description
Represents a language identifier and a region identifier

# paths./2/profile.patch.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile.patch.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile.patch.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile.patch.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/profile.patch.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.validation_failed: Triggered when the input send does not pass the validation rule.

# paths./2/profile.patch.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./2/profile.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/emails.get.description
Retrieve list of all email addresses of the current user's profile.

# paths./2/profile/emails.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/emails.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/emails.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/emails.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/emails.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/emails.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/emails/{email_type}/{email_id}.get.description
Get details of a specific email address of the current user's profile.

# paths./2/profile/emails/{email_type}/{email_id}.get.parameters[].description
The email type (email|email_request) to request.

# paths./2/profile/emails/{email_type}/{email_id}.get.parameters[].description
The unique identifier (ID) of the email to request.

# paths./2/profile/emails/{email_type}/{email_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/emails/{email_type}/{email_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/emails/{email_type}/{email_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/emails/{email_type}/{email_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/emails/{email_type}/{email_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/emails/{email_type}/{email_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/emails/{email_type}/{email_id}.delete.description
Delete an email address of the current user's profile.

# paths./2/profile/emails/{email_type}/{email_id}.delete.parameters[].description
The email type (email|email_request) to request.

# paths./2/profile/emails/{email_type}/{email_id}.delete.parameters[].description
The unique identifier (ID) of the email to request.

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./2/profile/emails/{email_type}/{email_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/phones.get.description
This endpoint allows you to retrieve all the phones of the current user.

# paths./2/profile/phones.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/phones.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/phones.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/phones.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/phones.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/phones.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/phones/{phone_id}.get.description
Returns a variety of information about a single phone specified by the requested unique identifier.

# paths./2/profile/phones/{phone_id}.get.parameters[].description
The unique identifier (ID) of the phone to request.

# paths./2/profile/phones/{phone_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/phones/{phone_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/phones/{phone_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/phones/{phone_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/phones/{phone_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/phones/{phone_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/phones/{phone_id}.delete.parameters[].description
The unique identifier (ID) of the phone to request.

# paths./2/profile/phones/{phone_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/phones/{phone_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/phones/{phone_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/phones/{phone_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/phones/{phone_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/phones/{phone_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/phones/{phone_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/phones/{phone_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./2/profile/phones/{phone_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/applications/passwords/{password_id}.get.description
Returns a variety of information about a single application password specified by the requested unique identifier.

# paths./2/profile/applications/passwords/{password_id}.get.parameters[].description
The unique identifier (ID) of the password to request.

# paths./2/profile/applications/passwords/{password_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/applications/passwords/{password_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/applications/passwords/{password_id}.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/applications/passwords/{password_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/applications/passwords/{password_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/applications/passwords/{password_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/2fa/authenticator/passkeys.get.tags[]
Profile > Two Factor > Authenticator > Passkeys

# paths./2/profile/2fa/authenticator/passkeys.get.description
List the active Authenticator Passkeys for the current User.

# paths./2/profile/2fa/authenticator/passkeys.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/2fa/authenticator/passkeys.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/2fa/authenticator/passkeys.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/2fa/authenticator/passkeys.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/profile/2fa/authenticator/passkeys.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/profile/2fa/authenticator/passkeys.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/2fa/authenticator/passkeys.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/2fa/authenticator/passkeys.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/2fa/authenticator/passkeys.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.tags[]
User Management > Accounts > Invitations > Drive

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.description
This API endpoint allows you to revoke access to the specified drive, for an invitation of a user in an account

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.product_is_part_of_ksuite: Triggered when product is part of ksuite.

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_already_exists: Triggered when the entity already exists.

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens. cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.patch.tags[]
User Management > Accounts > Invitations > Drive

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.patch.description
This API endpoint allows you to edit futurs rights into specified drive, for an invitation of a user in an account

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.patch.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/accounts/{account}/invitations/{invitation}/drive/{drive_id}.patch.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/kchat.patch.tags[]
User Management > Accounts > Invitations > KChat

# paths./1/accounts/{account}/invitations/{invitation}/kchat.patch.description
This API endpoint allows you to update role of kchat app access

# paths./1/accounts/{account}/invitations/{invitation}/kchat.patch.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/accounts/{account}/invitations/{invitation}/kchat.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/accounts/{account}/invitations/{invitation}/kchat.patch.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/tags/{tag}.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/tags/{tag}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./1/accounts/{account}/tags/{tag}.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/tags/{tag}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./1/accounts/{account}/tags/{tag}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./1/accounts/{account}/tags/{tag}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/ksuites/mailboxes/{mailbox_id}/set_primary.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/ksuites/mailboxes/{mailbox_id}/set_primary.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./2/profile/ksuites/mailboxes/{mailbox_id}/set_primary.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/ksuites/mailboxes/{mailbox_id}/update_password.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/ksuites/mailboxes/{mailbox_id}/update_password.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./2/profile/ksuites/mailboxes/{mailbox_id}/update_password.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/accounts/{account}/invitations/{invitation}/b2b/{partnership_.delete.tags[]
User Management > Accounts > Invitations > B2B

# paths./1/accounts/{account}/invitations/{invitation}/b2b/{partnership_.delete.description
This API endpoint allows you to revoke customer access for a user invitation of a partner account

# paths./2/profile/ksuites/mailboxes/{mailbox_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/ksuites/mailboxes/{mailbox_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./2/profile/ksuites/mailboxes/{mailbox_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.tags[]
Profile > Two Factor > Authenticator > Passkeys

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.description
Delete an active Authenticator Passkey for the current User.

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./2/profile/2fa/authenticator/passkeys/{passkey}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/ai.get.description
List all AI products where you have a technical right

# paths./1/ai/models.get.parameters[].schema.description
Get models available on this endpoint.<br>For instance, if `post/2/ai/{product_id}/openai/v1/embeddings` is given, it will return all the models that are available on this endpoint.

# paths./1/ai/models.get.parameters[].schema.description
Get models available to at least one endpoint that contains the given part.<br>For instance, if `chat/completions` is given, it will return all the models that are available on at least one endpoint that contains `chat/completions`.

# paths./1/ai/models.get.parameters[].schema.description
Get the model from its exact name, as it is unique, 0 or 1 model are returned.<br>The value may contain a slash, hence it must be URL-encoded, for instance `mistralai%2FMinistral-3-14B-Instruct-2512` for value `mistralai/Ministral-3-14B-Instruct-2512`.

# paths./1/ai/models.get.parameters[].schema.description
Get models whose name contain the given string, so 0+ model(s) are returned.<br>The value may contain a slash, hence it must be URL-encoded, for instance `mistralai%2FMinistral` for value `mistralai/Ministral`.

# paths./1/ai/{product_id}/consumptions.get.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/consumptions.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/ai/{product_id}/consumptions.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/ai/{product_id}/results/{batch_id}.get.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/results/{batch_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/ai/{product_id}/results/{batch_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/ai/{product_id}/results/{batch_id}.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/ai/{product_id}/results/{batch_id}/download.get.summary
Download the output result of an async model batch

# paths./1/ai/{product_id}/results/{batch_id}/download.get.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/results/{batch_id}/download.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/ai/{product_id}/results/{batch_id}/download.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/ai/{product_id}/results/{batch_id}/download.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/ai/{product_id}/images/generations/photo_maker.post.description
To stylize the image, make sure to use the **class word** corresponding to the image you want to customize, followed by the **trigger word** `img`, for instance:
• man img
• woman img
• girl img

Example prompt:
> *Instagram photo, portrait photo of a woman img, colorful, perfect face, natural skin, hard shadows, film grain*

Upload the images of the individual you wish to customize.
While a single image is sufficient, providing additional images can yield better results.
Make sure that the face occupies the majority of the uploaded image.

# paths./1/ai/{product_id}/images/generations/photo_maker.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.guidance_scale.description
Weights for the prompt. Increasing guidance makes generation follow more closely to the prompt.

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.images.description
Upload the images of the individual you wish to customize. While a single image is sufficient, providing additional images can yield better results. Ensure that the face occupies the majority of the uploaded image.

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.n.description
The number of images to generate (default: 1)

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.negative_prompt.description
The prompt does not guide the image generation. The maximum length is 77 tokens.

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.prompt.description
Provide a text description to stylize the image. Make sure to follow the class word you want to customize with the trigger word: img, such as: man img, woman img, or girl img.

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.prompt.example
sci-fi, closeup portrait photo of a man img wearing sunglasses in an Iron Man suit, face, slim body, high quality, film grain

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.quality.description
The quality of the image that will be generated (default: standard)

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.response_format.description
The format in which the generated images are returned. Currently, only 'b64_json' is supported as the response format

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.style.description
Change the style to guidance for the generation

# paths./1/ai/{product_id}/images/generations/photo_maker.post.requestBody.content.application/json.schema.properties.style_strength_ratio.description
Adjust the Style strength to 15-50. The larger the number, the less ID fidelity, but the stylization ability will be better.

# paths./1/ai/{product_id}/openai/models.get.description
**Deprecated route:** please use the new full OpenAI-compliant route
[POST `/2/ai/{product_id}/openai/v1/models`](/2/ai/{product_id}/openai/v1/models)
<br><br>
Retrieves a list of models with the [OpenAI format](https://platform.openai.com/docs/api-reference/models/list)

# paths./1/ai/{product_id}/openai/models.get.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/openai/chat/completions.post.description
**Deprecated route:** please use the new full OpenAI-compliant route
[POST `/2/ai/{product_id}/openai/v1/chat/completions`](/docs/api/post/2/ai/%7Bproduct_id%7D/openai/v1/chat/completions)
<br><br>
Creates a model response for the given chat conversation.<br>
The input and output format are the same as OpenAI API.
<br><br>
Supported language are: English, German, Spanish, French, Italian. And limited capabilities in Portuguese, Polish, Dutch, Romanian, Czech, Swedish.
<br><br>
By default, the number of requests per minute is rate limited.
If you wish to know the rate limite or increase this limit, please contact our support team for assistance.
<br><br>
Some models are in **beta** and may being subject to changes,
use [GET `/1/ai/models`](/docs/api/get/1/ai/models) to check what model are in **beta**
and see our [General Terms and Conditions](https://www.infomaniak.com/gtl/rgpd.documents).

# paths./1/ai/{product_id}/openai/chat/completions.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.frequency_penalty.description
Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.logit_bias.description
UNUSED Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.logprobs.description
Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.messages.items.properties.role.description
Message role in conversation: user,assistant

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.messages.items.description
A list of messages comprising the conversation so far.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.n.description
UNUSED How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.presence_penalty.description
The number should be above -2.0 but below 2.0. A positive value for the number will result in a penalty for any new tokens that are similar to those already present in the text, encouraging the model to discuss different topics. It is recommended to set the value between -1.5 and -0.5. Using higher values along with a larger temperature setting may cause a hallucination loop.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.profile_type.description
Define parameter profiles according to your usage preferences. Creativity encourages greater diversity in text generation. Standard settings offer a well-balanced chatbot output. Strict settings result in highly predictable generation, suitable for tasks like translation or text classification labeling.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.response_format.properties.type.description
The type of response format being defined.<br>**NOTE:** only `json_schema` is currently supported, `text` is the default behavior and should not be given, `json_object` is obsolete and is no longer supported.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.stop.description
Up to 4 sequences where the API will stop generating further tokens.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.temperature.description
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.top_logprobs.description
An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

# paths./1/ai/{product_id}/openai/chat/completions.post.requestBody.content.application/json.schema.properties.top_p.description
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.description
Transcribes audio into the input language.
The input format is the same as OpenAI, see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/audio/createTranscription).
This route is asynchronous, use
• [GET `/1/ai/{product_id}/results/{batch_id}`](/docs/api/get/1/ai/{product_id}/results/{batch_id}) to get the result
• [GET `/1/ai/{product_id}/results/{batch_id}/download`](/docs/api/get/1/ai/{product_id}/results/{batch_id}/download) to download the output once done

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.append_punctuations.description
Only if timestamp_granularities[]:word is True, merge these punctuation symbols with the previous word

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.chunk_length.description
Defines the maximum duration for an active segment in sec. For subtitle tasks, it's recommended to set this to a short duration (5-10 seconds) to avoid long sentences.

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.file.description
The audio file to transcribe.
Its size must be less than *Max lengh* in kilobytes.
Allowed types: `mp3,mp4,aac,wav,flac,ogg,opus,wma,m4a,webm`.

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.highlight_words.description
Subtitle task. Underline each word as it is spoken in srt and vtt output formats (requires timestamp_granularities[]:word)

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.language.description
The language of the input audio. Supplying the input language will translate the output.

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.max_line_count.description
Subtitle task. The maximum number of lines in a segment in srt and vtt output formats (requires timestamp_granularities[]:word)

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.max_line_width.description
Subtitle task. The maximum number of characters in a line before breaking the line in srt and vtt output formats (requires timestamp_granularities[]:word)

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.max_words_per_line.description
Subtitle task. The maximum number of words in a segment (requires timestamp_granularities[]:word)

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.no_speech_threshold.description
If the no_speech probability is higher than this value AND the average log probability over sampled tokens is below `log_prob_threshold`, consider the segment as silent.

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.prepend_punctuations.description
Only if timestamp_granularities[]:word is True, merge these punctuation symbols with the next word

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.prompt.description
An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.response_format.description
The format of the transcript output (default: json)

# paths./1/ai/{product_id}/openai/audio/transcriptions.post.requestBody.content.application/json.schema.properties.timestamp_granularities.description
The timestamp granularities to populate for this transcription. Either or both of these options are supported: word, or segment. Requires `response_format=verbose_json`. Defaults to segment.

# paths./1/ai/{product_id}/openai/images/generations.post.description
Creates an image given a prompt.
This route is mostly OpenAI-compliant, see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/images/create).
Supports English primarily, with limited understanding of French (FR), German (DE), Spanish (ES), and Italian (IT).

# paths./1/ai/{product_id}/openai/images/generations.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/openai/images/generations.post.requestBody.content.application/json.schema.properties.n.description
The number of images to generate (default: 1)

# paths./1/ai/{product_id}/openai/images/generations.post.requestBody.content.application/json.schema.properties.negative_prompt.description
The prompt does not guide the image generation. The maximum length is 77 tokens, Note that the "sdxl_lightning" and "flux" model does not support this feature.

# paths./1/ai/{product_id}/openai/images/generations.post.requestBody.content.application/json.schema.properties.prompt.description
A text description of the desired image(s). The maximum length is 77 tokens

# paths./1/ai/{product_id}/openai/images/generations.post.requestBody.content.application/json.schema.properties.quality.description
The quality of the image that will be generated (default: standard)

# paths./1/ai/{product_id}/openai/images/generations.post.requestBody.content.application/json.schema.properties.response_format.description
The format in which the generated images are returned. Currently, only 'b64_json' is supported as the response format

# paths./1/ai/{product_id}/openai/images/generations.post.requestBody.content.application/json.schema.properties.style.description
Change the style to guidance for the generation

# paths./1/ai/{product_id}/openai/v1/embeddings.post.description
**Deprecated route:** please use the new full OpenAI-compliant route
[POST `/2/ai/{product_id}/openai/v1/embeddings`](/docs/api/post/2/ai/{product_id}/openai/v1/embeddings)
<br><br>
Some models are in **beta** and may being subject to changes,
use [GET `/1/ai/models`](/docs/api/get/1/ai/models) to check what model are in **beta**
and see our [General Terms and Conditions](https://www.infomaniak.com/gtl/rgpd.documents).

# paths./1/ai/{product_id}/openai/v1/embeddings.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./1/ai/{product_id}/openai/v1/embeddings.post.requestBody.content.application/json.schema.properties.encoding_format.description
The encoding format of the returned embeddings. Defaults to float.

# paths./1/ai/{product_id}/openai/v1/embeddings.post.requestBody.content.application/json.schema.properties.input.description
Input text to embed. Is can be string, array of string, array of int (for tokenize sentence), array of array of int (batch of tokenize sentence)

# paths./1/ai/{product_id}/openai/v1/embeddings.post.requestBody.content.application/json.schema.properties.mode.description
Specify the mode of the embedding request.

# paths./1/ai/{product_id}/openai/v1/embeddings.post.requestBody.content.application/json.schema.properties.task_description.description
Optional set your custom task information in query mode

# paths./2/ai/{product_id}/cohere/v1/models.get.description
Cohere compatible models list, see the [Cohere documentation](https://docs.cohere.com/reference/list-models).
<br><br>
Lists the currently available models, and provides basic information about each one such as the owner and availability.
<br><br>
Some models are in **beta** and may being subject to changes,
use [GET `/1/ai/models`](/docs/api/get/1/ai/models) to check what model are in **beta**
and see our [General Terms and Conditions](https://www.infomaniak.com/gtl/rgpd.documents).

# paths./2/ai/{product_id}/cohere/v1/models.get.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.description
This endpoint takes in a query and a list of texts and produces an ordered array with each text assigned a relevance score.
It is intended to be *Cohere*-compliant, see their documentation: [Cohere: Rerank API (v2)](https://docs.Cohere.com/reference/rerank).
The main discrepancy with the *Cohere* standard is on consumptions data: while the *Cohere* standard is to return the object `meta`, this endpoint returns an object `usage` that is closer to *OpenAI* endpoints, especially the embedding one.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.requestBody.content.application/json.schema.properties.documents.items.description
Text items that will be compared to the `query`.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.requestBody.content.application/json.schema.properties.documents.description
A list of texts that will be compared to the `query`. For optimal performance we recommend against sending more than 1,000 documents in a single request.

**Note:** long documents will automatically be truncated to the value of `max_tokens_per_doc`.

**Note:** structured data should be formatted as YAML strings for best performance.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.requestBody.content.application/json.schema.properties.max_tokens_per_doc.description
**Defaults to `4096`**<br>Long documents will be automatically truncated to the specified number of tokens.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.requestBody.content.application/json.schema.properties.model.description
Model name to use<br>You can use the endpoint [GET `/1/ai/models`](/docs/api/get/1/ai/models) to see all our available models with various information.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.requestBody.content.application/json.schema.properties.priority.description
**Defaults to `0`**<br>Controls how early the request is handled. Lower numbers indicate higher priority (default: `0`, the highest). When the system is under load, higher-priority requests are processed first and are the least likely to be dropped.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.requestBody.content.application/json.schema.properties.query.description
The search query, *i.e.* the word/sentence/… to rank against `documents`

# paths./2/ai/{product_id}/cohere/v2/rerank.post.requestBody.content.application/json.schema.properties.query.example
Osmium, Iridium and Platinum are the 3 densest metals.

# paths./2/ai/{product_id}/cohere/v2/rerank.post.requestBody.content.application/json.schema.properties.top_n.description
Limits the number of returned rerank results to the specified value. If not passed, all the rerank results will be returned.

# paths./2/ai/{product_id}/openai/v1/models.get.description
OpenAI compatible models list, see the <a href="https://platform.openai.com/docs/api-reference/models/list">OpenAI documentation</a>.
<br><br>
Lists the currently available models, and provides basic information about each one such as the owner and availability.
<br><br>
Some models are in **beta** and may being subject to changes,
use [GET `/1/ai/models`](/docs/api/get/1/ai/models) to check what model are in **beta**
and see our [General Terms and Conditions](https://www.infomaniak.com/gtl/rgpd.documents).

# paths./2/ai/{product_id}/openai/v1/models.get.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./2/ai/{product_id}/openai/v1/completions.post.description
OpenAI compatible completion, see the [OpenAI documentation](https://developers.openai.com/api/reference/resources/completions/methods/create).
<br><br>
Some models are in **beta** and may being subject to changes,
use [GET `/1/ai/models`](/docs/api/get/1/ai/models) to check what model are in **beta**
and see our [General Terms and Conditions](https://www.infomaniak.com/gtl/rgpd.documents).
<br><br>
List of models available on this endpoint could be retrieve with [GET `/2/ai/{product_id}/openai/v1/models`](/docs/api/get/2/ai/{product_id}/openai/v1/models).

# paths./2/ai/{product_id}/openai/v1/completions.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.best_of.description
Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed.
When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than n.
**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.echo.description
Echo back the prompt in addition to the completion.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.frequency_penalty.description
Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim.<br>See [more information about frequency and presence penalties (OpenAI)](https://developers.openai.com/docs/guides/text-generation).

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.logit_bias.description
Modify the likelihood of specified tokens appearing in the completion.
Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from `-100` to `100`. You can use this [OpenAI tokenizer tool](https://developers.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between `-1` and `1` should decrease or increase likelihood of selection; values like `-100` or `100` should result in a ban or exclusive selection of the relevant token.
As an example, you can pass `{"50256": -100}` to prevent the `<|endoftext|>` token from being generated.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.logprobs.description
Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to `logprobs+1` elements in the response.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.max_tokens.description
The maximum number of tokens that can be generated in the completion.<br>The token count of your prompt plus max_tokens cannot exceed the model’s context length.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.model.description
Model name used to generate the response, like `qwen3` or `swiss-ai/Apertus-70B-Instruct-2509`. Infomaniak offers a wide range of models with different capabilities, performance characteristics, and price points. Use the endpoint [GET `/1/ai/models`](/docs/api/get/1/ai/models) to retrieve the models list with various informations.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.n.description
How many completions to generate for each prompt.<br>**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.presence_penalty.description
Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics.<br>See [more information about frequency and presence penalties (OpenAI)](https://developers.openai.com/docs/guides/text-generation).

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.prompt.items.description
The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.<br>Note that `<|endoftext|>` is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.seed.description
If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.
Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.
Format: `int64`.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.stop.description
Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.stream.description
Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.stream_options.properties.include_obfuscation.description
When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set `include_obfuscation` to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.stream_options.properties.include_usage.description
If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array.
All other chunks will also include a usage field, but with a null value.
**Note**: If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.stream_options.description
Options for streaming response. Only set this when you set `stream: true`.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.temperature.description
*Defaults to* `1`<br>What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.top_p.description
Defaults to `1`
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
We generally recommend altering this or `temperature` but not both.

# paths./2/ai/{product_id}/openai/v1/completions.post.requestBody.content.application/json.schema.properties.user.description
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. See [OpenAI documentation to learn more](https://developers.openai.com/docs/guides/safety-best-practices#end-user-ids)

# paths./2/ai/{product_id}/openai/v1/embeddings.post.description
OpenAI compatible embeddings, see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/embeddings/create).
<br><br>
Creates an embedding vector representing the input text.
<br><br>
Some models are in **beta** and may being subject to changes,
use [GET `/1/ai/models`](/docs/api/get/1/ai/models) to check what model are in **beta**
and see our [General Terms and Conditions](https://www.infomaniak.com/gtl/rgpd.documents).

# paths./2/ai/{product_id}/openai/v1/embeddings.post.parameters[].description
*AI Tools* product identifier: use [GET `/1/ai`](/docs/api/get/1/ai) to retrieve your product identifier.

# paths./2/ai/{product_id}/openai/v1/embeddings.post.requestBody.content.application/json.schema.properties.dimensions.description
The number of dimensions the resulting output embeddings should have. May not be supported by all the available models.

# paths./2/ai/{product_id}/openai/v1/embeddings.post.requestBody.content.application/json.schema.properties.encoding_format.description
*Defaults to* `float`<br>The format to return the embeddings in. Can be either `float` or `base64`.

# paths./2/ai/{product_id}/openai/v1/embeddings.post.requestBody.content.application/json.schema.properties.input.description
Input text to embed, encoded as **a string or array of tokens**. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.

# paths./2/ai/{product_id}/openai/v1/embeddings.post.requestBody.content.application/json.schema.properties.model.description
Model name to use. You can use the endpoint [GET `/1/ai/models`](/docs/api/get/1/ai/models) to see all our available models with various informations.

# paths./1/radios/ftp-access.get.summary
Check if the given ftp is the indes one.

# paths./1/radios/ftp-access.get.description
This endpoint allows you to check if the given ftp is an indes ftp.

# paths./1/radios/ftp-access.get.x-capabilities[].description
Limit a request's results and define from which item you want the results

# paths./1/radios/ftp-access.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.description
This endpoint allows you to list steps of an advanced playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.parameters[].description
The universal unique identifier (UUID) of the VOD composite mixtape.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.delete.description
This endpoint allows you to delete all steps of an advanced playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.delete.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.delete.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.delete.parameters[].description
The universal unique identifier (UUID) of the VOD composite mixtape.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.description
This endpoint allows you to preview one or more cycles of an advanced playlist.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.parameters[].description
The universal unique identifier (UUID) of the VOD composite mixtape.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.post.description
This endpoint allows you to synchronize all steps of an advanced playlist.
It deletes existing steps and replaces them with the provided list.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.post.parameters[].description
The unique identifier (ID) of the radio product to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.post.parameters[].description
The unique identifier (ID) of the station to request.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.post.parameters[].description
The universal unique identifier (UUID) of the VOD composite mixtape.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./1/radios/{radio_product_id}/stations/{station_id}/autodj/advanc.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive.get.description
List of accessible drive for the current connected user

# paths./2/drive.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive.get.parameters[].schema.description
True for any maintenance, False for no maintenance.

# paths./2/drive.get.parameters[].schema.items.description
Reason of {name} maintenance.demo_end: The demonstration period of the {name} has come to an end. invoice_overdue: An invoice for this {name} is currently unpaid. not_renew: This {name} has expired and must be renewed.

# paths./2/drive.get.parameters[].schema.description
Array of maintenance reasons. Ignored if `in_maintenance` is set.

# paths./2/drive.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/users.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/users.get.parameters[].schema.description
Search a user by his firstname, lastname or email

# paths./2/drive/users.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/users/{user_id}/drives.get.description
List of accessible drive of a specific user

# paths./2/drive/users/{user_id}/drives.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/users/{user_id}/drives.get.parameters[].schema.items.description
Administration level of the user.admin: Administrator of the drive, can manage the drive (settings, invitations and users) and the files. external: External user can only access the files given by the others roles. user: Internal user can invite user and manage the files of his private directory and other directories with manage file access.

# paths./2/drive/users/{user_id}/drives.get.parameters[].schema.items.description
Current access status of the user in the drive.active: User has access to the Drive. deleted_kept: User has been removed but his data remain in the drive. deleted_removed: User has been removed. deleted_transferred: User has been removed and his data has been transferred to another user. deleted_transferring: User has been removed and is being transferred to another user. locked: User has been locked, user can no longer access to the drive. pending: User has not accepted the invitation request.

# paths./2/drive/users/{user_id}/drives.get.parameters[].schema.description
Filter by status, if nothing provided active status is chosen

# paths./2/drive/users/{user_id}/drives.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/users/{user_id}/drives.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/users/{user_id}/drives.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/users/{user_id}/drives.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/users/{user_id}/drives.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/drive/users/{user_id}/drives.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/users/{user_id}/drives.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/preferences.get.description
Get the user drive preference ex: notification, date-format, list order etc...

# paths./2/drive/preferences.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/preferences.patch.description
Update the user drive preference ex: notification, date-format, list order etc...

# paths./2/drive/{drive_id}/categories/rights.get.description
Returns all rights related to categories on drive

# paths./2/drive/{drive_id}/categories/rights.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/categories/rights.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.category_right_error: Action impossible. No permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/categories/rights.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories/rights.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/categories/rights.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/categories/rights.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories/rights.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/categories/rights.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.category_error: Action impossible, request invalid.

# paths./2/drive/{drive_id}/categories/rights.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories/rights.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/categories/rights.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.category_right_error: Action impossible. No permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/categories/rights.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories/rights.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/categories/rights.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/categories/rights.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/categories.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/categories.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/categories.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/categories.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories.post.description
Creates a new category with name and color

# paths./2/drive/{drive_id}/categories.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/categories.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/categories.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/categories.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/categories.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories/{category_id}.put.description
Edits the name and color of a category by identifier

# paths./2/drive/{drive_id}/categories/{category_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/categories/{category_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/categories/{category_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories/{category_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/categories/{category_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/categories/{category_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/categories/{category_id}.post.description
Adds an existing category on a set of files

# paths./2/drive/{drive_id}/files/categories/{category_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/categories/{category_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/categories/{category_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/categories/{category_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/categories/{category_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/categories/{category_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/categories.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/categories.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/categories.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/categories.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/categories.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/categories.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}/ai-.post.description
Validates the category as correct or incorrect, according to `valid` parameter.

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}/ai-.post.requestBody.content.application/json.schema.properties.valid.description
True if category is correct, False if incorrect. Removes category if False.

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}/ai-.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}/ai-.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}/ai-.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}/ai-.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}/ai-.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/categories/{category_id}/ai-.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/settings.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/settings.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/settings.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/settings.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/ai.put.requestBody.content.application/json.schema.properties.has_approved_ai_categories.description
If the `User` consents to automatic `Categories` on `Files`.

# paths./2/drive/{drive_id}/settings/ai.put.requestBody.content.application/json.schema.properties.has_approved_content_search.description
If the `User` consents to search in `Files` contents.

# paths./2/drive/{drive_id}/settings/ai.put.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/settings/ai.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.content_advanced_search_require_base_error: Unable to activate document search as this drive does not yet have the new search engine. content_advanced_search_currently_being_activated_error: Unable to deactivate document search as it is already being activated. content_advanced_search_currently_being_deactivated_error: Unable to activate document search as it is already being deactivated.

# paths./2/drive/{drive_id}/settings/ai.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/ai.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/settings/ai.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/settings/ai.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/ai.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/settings/ai.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/settings/ai.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/ai.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/settings/ai.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/drive/{drive_id}/settings/ai.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/ai.put.responses.417.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 417

# paths./2/drive/{drive_id}/settings/ai.put.responses.417.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.content_advanced_search_not_compatible_with_this_offer_error: Unable to activate document search as current kDrive offering is not compatible.

# paths./2/drive/{drive_id}/settings/ai.put.responses.417.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/ai.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/drive/{drive_id}/settings/ai.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./2/drive/{drive_id}/settings/ai.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/ai.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/settings/ai.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/settings/ai.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/link.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/settings/link.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/settings/link.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/link.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/settings/link.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/settings/link.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/link.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/settings/link.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/drive/{drive_id}/settings/link.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/link.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/drive/{drive_id}/settings/link.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./2/drive/{drive_id}/settings/link.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/link.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/settings/link.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/settings/link.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/trash.put.description
Update the trash settings, including the retention period of trashed files

# paths./2/drive/{drive_id}/settings/trash.put.requestBody.content.application/json.schema.properties.max_duration.description
Number of days to keep file in trash. The unit is in days, and the available values depend on your offer. check pack.limit.trash.options: /drive/{drive_id}

# paths./2/drive/{drive_id}/settings/trash.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/settings/trash.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/settings/trash.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/trash.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/settings/trash.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/settings/trash.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/trash.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/settings/trash.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/drive/{drive_id}/settings/trash.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/trash.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/drive/{drive_id}/settings/trash.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./2/drive/{drive_id}/settings/trash.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/trash.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/settings/trash.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/settings/trash.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/files/private.put.requestBody.content.application/json.schema.properties.size_threshold.description
Maximal allowed size for the private folder (in bytes)<note> `null` no size restriction</note>

# paths./2/drive/{drive_id}/settings/files/private.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/settings/files/private.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/settings/files/private.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/files/private.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/settings/files/private.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/settings/files/private.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/files/private.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/settings/files/private.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/settings/files/private.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/report/storage_report.put.requestBody.content.application/json.schema.properties.frequency.description
Report frequency.monthly: Sent every month. never: Never sent. semi-monthly: Sent every two week. weekly: Sent every week.

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/settings/report/storage_report.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/office.put.description
Update the office settings, the default opening office editor

# paths./2/drive/{drive_id}/settings/office.put.requestBody.content.application/json.schema.properties.form.description
List of applications.365: The 365 application. onlyoffice: The onlyoffice application.

# paths./2/drive/{drive_id}/settings/office.put.requestBody.content.application/json.schema.properties.presentation.description
List of applications.365: The 365 application. onlyoffice: The onlyoffice application.

# paths./2/drive/{drive_id}/settings/office.put.requestBody.content.application/json.schema.properties.spreadsheet.description
List of applications.365: The 365 application. onlyoffice: The onlyoffice application.

# paths./2/drive/{drive_id}/settings/office.put.requestBody.content.application/json.schema.properties.text.description
List of applications.365: The 365 application. onlyoffice: The onlyoffice application.

# paths./2/drive/{drive_id}/settings/office.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/settings/office.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/settings/office.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/office.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/settings/office.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/settings/office.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/office.put.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/settings/office.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/drive/{drive_id}/settings/office.put.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/office.put.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/drive/{drive_id}/settings/office.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./2/drive/{drive_id}/settings/office.put.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/settings/office.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/settings/office.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/settings/office.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/users.get.parameters[].schema.description
Search user by his first name, last name or email

# paths./2/drive/{drive_id}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/users.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/users.post.requestBody.content.application/json.schema.properties.file_id.description
For adding a file shared along the invitation.

# paths./2/drive/{drive_id}/users.post.requestBody.content.application/json.schema.properties.lang.description
Invitation language fallback if user's preference is not found

# paths./2/drive/{drive_id}/users.post.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/users.post.requestBody.content.application/json.schema.properties.role.description
Administration level of the user.admin: Administrator of the drive, can manage the drive (settings, invitations and users) and the files. external: External user can only access the files given by the others roles. user: Internal user can invite user and manage the files of his private directory and other directories with manage file access.

# paths./2/drive/{drive_id}/users.post.requestBody.content.application/json.schema.properties.type.description
Type of the access; this field is no longer used and has been replaced by an additional role property `external`.main: User has access to the drive. shared: User has access to a shared file / directory only.

# paths./2/drive/{drive_id}/users.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/users/invitation.get.parameters[].schema.items.description
External file import status.accepted: Invitation has been accepted. cancelled: Invitation has been cancelled. expired: Invitation is expired. pending: Invitation still pending. rejected: Invitation has been rejected.

# paths./2/drive/{drive_id}/users/invitation.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/invitation.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/invitation.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/invitation.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/invitation.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.get.description
Get all invitation information from invitation id

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.description
Update information pertaining to an invitation identified by its invitation id

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.requestBody.content.application/json.schema.properties.role.description
Administration level of the user.admin: Administrator of the drive, can manage the drive (settings, invitations and users) and the files. user: Internal user can invite user and manage the files of his private directory and other directories with manage file access.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.enum[]
Invitation already exists with this email

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.responses.400.content.application/json.examples.Invitation already exists with this email.value.error.description
Invitation already exists with this email

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.delete.description
Delete an invitation by its invitation id

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}/send.post.description
Refresh invitation validity and send email according to invitation type.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}/send.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}/send.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}/send.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}/send.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}/send.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/invitation/{invitation_id}/send.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}.get.description
Returns a user resource. When no resource is found, the data is empty.

# paths./2/drive/{drive_id}/users/{user_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/{user_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/{user_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/{user_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/{user_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}.put.requestBody.content.application/json.schema.properties.role.description
Administration level of the user.admin: Administrator of the drive, can manage the drive (settings, invitations and users) and the files. user: Internal user can invite user and manage the files of his private directory and other directories with manage file access.

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.can_not_update_role_error: User is not allowed to update someone's role.

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_user_name_already_exists_error: Drive username already exists.

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/{user_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}.delete.description
Deletes a drive user resource. Also removes all access, share links and invitations associated with the user.

# paths./2/drive/{drive_id}/users/{user_id}.delete.requestBody.content.application/json.schema.properties.notify.description
Whether the deleted user should be notified by email, false by default.

# paths./2/drive/{drive_id}/users/{user_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/{user_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/{user_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/{user_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/{user_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}/manager.patch.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/{user_id}/manager.patch.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/{user_id}/manager.patch.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}/manager.patch.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/{user_id}/manager.patch.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/{user_id}/manager.patch.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}/lock.post.description
Sets status to locked, preventing access to drive.

# paths./2/drive/{drive_id}/users/{user_id}/lock.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/{user_id}/lock.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/{user_id}/lock.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}/lock.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/{user_id}/lock.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/{user_id}/lock.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}/unlock.post.description
Sets status to active, restoring access to drive.

# paths./2/drive/{drive_id}/users/{user_id}/unlock.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/users/{user_id}/unlock.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/users/{user_id}/unlock.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/users/{user_id}/unlock.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/users/{user_id}/unlock.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/users/{user_id}/unlock.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities.get.description
Get all activities from drive as defined in options

# paths./2/drive/{drive_id}/activities.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/activities.get.parameters[].description
Override the language of the request, in most cases when an e-mail is triggered in the request.

# paths./2/drive/{drive_id}/activities.get.parameters[].schema.items.description
Logged interaction type of activities on the drive or file.acl_insert: Technical: when a new group access to a file/directory is create. acl_main_users_insert: Logged when the main kDrive team access to a file/directory is created. acl_main_users_remove: Logged when the main kDrive team to a file/directory is removed. acl_main_users_update: Logged when the main kDrive team to a file/directory is modified. acl_remove: Technical: when a group access to a file/directory is removed. acl_team_insert: Logged when a team access to a file/directory is created. acl_team_remove: Logged when a team access to a file/directory is removed. acl_team_update: Logged when a team access to a file/directory is modified. acl_update: Technical: when a group access to a file/directory is modified. acl_user_insert: Logged when an user/admin access to a file/directory is created. acl_user_remove: Logged when an user/admin access to a file/directory is removed. acl_user_update: Logged when an user/admin access to a file/directory is modified. category_create: Logged when a new category is added. category_delete: Logged when a category is deleted. category_update: Logged when a category is renamed. collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. exchange_pro_create: Technical: no used. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. file_update_mime_type: Logged when a file mime_type is updated. maintenance_added: Logged when a maintenance start. maintenance_removed: Logged when a maintenance ends. rewind_ended: Logged when the user ended a rewind. rewind_started: Logged when the user started a rewind. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified. trash_empty: Logged when the user empties the trash. trash_empty_auto: Logged when the trash empties old files automatically. update_trash_settings: Logged when the user changes trash the settings. user_connected: Logged when an user is connected to the drive. user_create: Logged when an user/admin is added to the drive. user_delete: Logged when an user/admin has been removed of the drive. user_restore: Logged when an user/admin has been restored of the drive. user_update: Logged when an user/admin information has changed.

# paths./2/drive/{drive_id}/activities.get.parameters[].schema.description
List of files for which to retrieve activities

# paths./2/drive/{drive_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/activities/reports.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/activities/reports.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/activities/reports.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/activities/reports.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/activities/reports.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/activities/reports.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/activities/reports.post.parameters[].description
Override the language of the request, in most cases when an e-mail is triggered in the request.

# paths./2/drive/{drive_id}/activities/reports.post.requestBody.content.application/json.schema.properties.actions.items.description
Logged interaction type of activities on the drive or file.acl_insert: Technical: when a new group access to a file/directory is create. acl_main_users_insert: Logged when the main kDrive team access to a file/directory is created. acl_main_users_remove: Logged when the main kDrive team to a file/directory is removed. acl_main_users_update: Logged when the main kDrive team to a file/directory is modified. acl_remove: Technical: when a group access to a file/directory is removed. acl_team_insert: Logged when a team access to a file/directory is created. acl_team_remove: Logged when a team access to a file/directory is removed. acl_team_update: Logged when a team access to a file/directory is modified. acl_update: Technical: when a group access to a file/directory is modified. acl_user_insert: Logged when an user/admin access to a file/directory is created. acl_user_remove: Logged when an user/admin access to a file/directory is removed. acl_user_update: Logged when an user/admin access to a file/directory is modified. category_create: Logged when a new category is added. category_delete: Logged when a category is deleted. category_update: Logged when a category is renamed. collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. exchange_pro_create: Technical: no used. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. file_update_mime_type: Logged when a file mime_type is updated. maintenance_added: Logged when a maintenance start. maintenance_removed: Logged when a maintenance ends. rewind_ended: Logged when the user ended a rewind. rewind_started: Logged when the user started a rewind. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified. trash_empty: Logged when the user empties the trash. trash_empty_auto: Logged when the trash empties old files automatically. update_trash_settings: Logged when the user changes trash the settings. user_connected: Logged when an user is connected to the drive. user_create: Logged when an user/admin is added to the drive. user_delete: Logged when an user/admin has been removed of the drive. user_restore: Logged when an user/admin has been restored of the drive. user_update: Logged when an user/admin information has changed.

# paths./2/drive/{drive_id}/activities/reports.post.requestBody.content.application/json.schema.properties.files.description
List of files for which to retrieve activities

# paths./2/drive/{drive_id}/activities/reports.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/activities/reports.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/activities/reports.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/activities/reports.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/activities/reports.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports/{report_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/activities/reports/{report_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/activities/reports/{report_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/activities/reports/{report_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports/{report_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/activities/reports/{report_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/activities/reports/{report_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports/{report_id}.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/activities/reports/{report_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.report_does_not_exist_error: Report not found.

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/activities/reports/{report_id}/export.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/sizes.get.description
Chart data, list files size value over time

# paths./2/drive/{drive_id}/statistics/sizes.get.parameters[].schema.description
Date from which to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/sizes.get.parameters[].schema.description
Statistics hours interval between from and until

# paths./2/drive/{drive_id}/statistics/sizes.get.parameters[].schema.description
Date until when to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.no_metrics_requested_error: No metrics were requested.

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/statistics/sizes.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/sizes/export.get.parameters[].schema.description
Date from which to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/sizes/export.get.parameters[].schema.description
Statistics hours interval between from and until

# paths./2/drive/{drive_id}/statistics/sizes/export.get.parameters[].schema.description
Date until when to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.no_metrics_requested_error: No metrics were requested.

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/statistics/sizes/export.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/users.get.parameters[].schema.description
Date from which to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/users.get.parameters[].schema.description
Date until when to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/users.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/statistics/activities/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/statistics/activities/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/users.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/statistics/activities/users.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/statistics/activities/users.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/shared_files.get.parameters[].schema.description
Date from which to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/shared_files.get.parameters[].schema.description
Date until when to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/shared_files.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/statistics/activities/shared_files.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/statistics/activities/shared_files.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/shared_files.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/statistics/activities/shared_files.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/statistics/activities/shared_files.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities.get.description
Chart data of activities metrics over time

# paths./2/drive/{drive_id}/statistics/activities.get.parameters[].schema.description
Date from which to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities.get.parameters[].schema.description
Statistics hours interval between from and until

# paths./2/drive/{drive_id}/statistics/activities.get.parameters[].schema.description
Date until when to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/statistics/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/statistics/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/statistics/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/statistics/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/export.get.parameters[].schema.description
Date from which to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/export.get.parameters[].schema.description
Statistics hours interval between from and until

# paths./2/drive/{drive_id}/statistics/activities/export.get.parameters[].schema.description
Date until when to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/export.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/statistics/activities/export.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/statistics/activities/export.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/export.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/statistics/activities/export.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/statistics/activities/export.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/links.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/statistics/activities/links.get.parameters[].schema.description
Date from which to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/links.get.parameters[].schema.items.description
Rights required to view the share link.inherit: Share link is accessible only by users of the drive. password: Share link is public but protected by a password. public: Share link is public, no restriction set.

# paths./2/drive/{drive_id}/statistics/activities/links.get.parameters[].schema.description
 Search the exact match of share link filename when file is asked.

# paths./2/drive/{drive_id}/statistics/activities/links.get.parameters[].schema.description
Date until when to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/statistics/activities/links.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/links.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.parameters[].schema.description
Date from which to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.parameters[].schema.items.description
Rights required to view the share link.inherit: Share link is accessible only by users of the drive. password: Share link is public but protected by a password. public: Share link is public, no restriction set.

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.parameters[].schema.description
Date until when to get statistics in unix-timestamp format

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/statistics/activities/links/export.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/preferences.put.description
Updates the connected user preference for a drive.

# paths./2/drive/{drive_id}/preferences.put.requestBody.content.application/json.schema.properties.ui.properties.rag_ocr_promotion.description
Display a promotion message about the RAG OCR if the user has not seen it yet

# paths./2/drive/{drive_id}/preferences.put.requestBody.content.application/json.schema.properties.ui.properties.storage_limit_alert.description
Display an alert when storage limit has been reached

# paths./2/drive/{drive_id}/preferences.put.requestBody.content.application/json.schema.properties.ui.properties.storage_warning_alert.description
Display an alert when storage limit is about to be reached

# paths./2/drive/{drive_id}/preferences.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/preferences.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/preferences.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/preferences.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/preferences.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/preferences.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports.get.description
List all external imports for the current user

# paths./2/drive/{drive_id}/imports.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/imports.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/imports.delete.description
Clean imports history for the current user.

# paths./2/drive/{drive_id}/imports.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/sharelink.post.description
Import the content of a kDrive sharelink

# paths./2/drive/{drive_id}/imports/sharelink.post.requestBody.content.application/json.schema.properties.destination_folder_id.description
ID of the destination folder for the copy

# paths./2/drive/{drive_id}/imports/sharelink.post.requestBody.content.application/json.schema.properties.except_file_ids.description
Ids of files to be imported. If missing or empty, all files of the share link will be imported

# paths./2/drive/{drive_id}/imports/sharelink.post.requestBody.content.application/json.schema.properties.file_ids.description
Ids of files to be imported. If missing or empty, all files of the share link will be imported

# paths./2/drive/{drive_id}/imports/sharelink.post.requestBody.content.application/json.schema.properties.password.description
Password to access the sharelink, if password-protected

# paths./2/drive/{drive_id}/imports/sharelink.post.requestBody.content.application/json.schema.properties.sharelink_token.description
Encrypted, base64 sharelink token to use for password-protected sharelink instead of clear password

# paths./2/drive/{drive_id}/imports/sharelink.post.requestBody.content.application/json.schema.properties.source_drive_id.description
ID of the kDrive containing the sharelink to copy

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.quota_exceeded_error: Triggered when the quota storage of the drive is reached.

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.external_import_in_progress_in_directory_error: Cannot perform action on the directory because an external import is in progress. external_import_unsupported_app_error: The provided application is unsupported and cannot be used for an external import.

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports/sharelink.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/kdrive.post.requestBody.content.application/json.schema.properties.application_drive_id.description
Id of the kDrive containing the content to import

# paths./2/drive/{drive_id}/imports/kdrive.post.requestBody.content.application/json.schema.properties.source_path.description
Path of the folder to import, if different from the root

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.quota_exceeded_error: Triggered when the quota storage of the drive is reached.

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.external_import_in_progress_in_directory_error: Cannot perform action on the directory because an external import is in progress. external_import_unsupported_app_error: The provided application is unsupported and cannot be used for an external import.

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports/kdrive.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/oauth.post.description
Import files and folders from a third party app supporting OAuth2

# paths./2/drive/{drive_id}/imports/oauth.post.requestBody.content.application/json.schema.properties.access_token_id.description
ID of the authentication token for the application

# paths./2/drive/{drive_id}/imports/oauth.post.requestBody.content.application/json.schema.properties.application.description
Supported service or third-party service identifier for external import.dropbox: Import from Dropbox. onedrive: Import from Microsoft OneDrive.

# paths./2/drive/{drive_id}/imports/oauth.post.requestBody.content.application/json.schema.properties.skip_shared_files.description
Skip shared files during the import, if the application supports it

# paths./2/drive/{drive_id}/imports/oauth.post.requestBody.content.application/json.schema.properties.source_path.description
Path of the folder to import, if different from the root

# paths./2/drive/{drive_id}/imports/oauth.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/imports/oauth.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.quota_exceeded_error: Triggered when the quota storage of the drive is reached.

# paths./2/drive/{drive_id}/imports/oauth.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/oauth.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports/oauth.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports/oauth.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/oauth.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/drive/{drive_id}/imports/oauth.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.external_import_in_progress_in_directory_error: Cannot perform action on the directory because an external import is in progress. external_import_unsupported_app_error: The provided application is unsupported and cannot be used for an external import.

# paths./2/drive/{drive_id}/imports/oauth.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/oauth.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports/oauth.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports/oauth.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/oauth/drives.get.description
List all drives eligible for import for the given third party application supporting OAuth2

# paths./2/drive/{drive_id}/imports/oauth/drives.get.parameters[].schema.description
ID of the authentication token for the application

# paths./2/drive/{drive_id}/imports/oauth/drives.get.parameters[].schema.description
Supported service or third-party service identifier for external import.dropbox: Import from Dropbox. onedrive: Import from Microsoft OneDrive.

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_found_error: The requested data was not found.

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.external_import_unsupported_app_error: The provided application is unsupported and cannot be used for an external import.

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports/oauth/drives.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/{import_id}.get.description
List all files which couldn't be imported properly.

# paths./2/drive/{drive_id}/imports/{import_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/imports/{import_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports/{import_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports/{import_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/{import_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports/{import_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports/{import_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/{import_id}.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.external_import_unsuitable_status_error: The provided import is not in a suitable status for this operation.

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports/{import_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/{import_id}/cancel.put.description
Cancel an external import.
This returns with a success if the import is already canceled or has ended.

Actual cancellation may take up to a few minutes to be effective

# paths./2/drive/{drive_id}/imports/{import_id}/cancel.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/imports/{import_id}/cancel.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/imports/{import_id}/cancel.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/imports/{import_id}/cancel.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/imports/{import_id}/cancel.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/imports/{import_id}/cancel.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/cancel.post.description
Cancel an action with a token or cancel actions with tokens.
An action token is a token returned with a CancelResource.
Used in bulk processes or specific actions like renaming a file.

# paths./2/drive/{drive_id}/cancel.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/cancel.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/cancel.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/cancel.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/cancel.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/drive/{drive_id}/cancel.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/cancel.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/drive/{drive_id}/cancel.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./2/drive/{drive_id}/cancel.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/cancel.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/cancel.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/cancel.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/access/requests/{request_id}.get.tags[]
Drive > Files > File/Directory > Access > Request

# paths./2/drive/{drive_id}/access/requests/{request_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/access/requests/{request_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/access/requests/{request_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/access/requests/{request_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/access/requests/{request_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/access/requests/{request_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/access/requests/{request_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/access/requests/{request_id}/decline.put.tags[]
Drive > Files > File/Directory > Access > Request

# paths./2/drive/{drive_id}/access/requests/{request_id}/decline.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/access/requests/{request_id}/decline.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/access/requests/{request_id}/decline.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/access/requests/{request_id}/decline.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/access/requests/{request_id}/decline.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/access/requests/{request_id}/decline.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_delete_object: Triggered when the entity cannot be deleted.

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/favorite.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/favorite.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/favorite.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/favorite.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/favorite.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/favorite.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/favorite.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/favorite.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/favorite.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/favorite.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/favorite.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/favorite.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/thumbnail.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/thumbnail.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/thumbnail.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/thumbnail.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/thumbnail.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/thumbnail.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.parameters[].schema.description
The height of the preview. <note>This parameter only works on image</note>

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.parameters[].schema.description
The quality of the preview. <note>This parameter only works on image</note>

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.parameters[].schema.description
The width of the preview. <note>This parameter only works on image</note>

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.parameters[].schema.description
File password to open it for conversion, if the file is password-protected

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/preview.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/download.get.description
Download file content or directory as Zip file.

<note>
Please note that this may respond a 302 to actually download the requested content.
</note>

# paths./2/drive/{drive_id}/files/{file_id}/download.get.parameters[].schema.description
File password to open it for conversion, if the file is password-protected

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.bad_request_error: Bad request, the request is invalid.

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/download.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/rename.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/rename.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/rename.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/rename.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/rename.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/rename.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/sizes.get.description
Get the size and storage_size of the File/Directory with children, up to $depth.

# paths./2/drive/{drive_id}/files/{file_id}/sizes.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/sizes.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/sizes.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/sizes.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/sizes.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/sizes.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/hash.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/hash.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/hash.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/hash.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/hash.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/hash.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.description
Copy source file in source drive to destination drive at destination folder.

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.external_import_size_computation_failed_error: Computing the import size failed; the import can't be executed. quota_exceeded_error: Triggered when the quota storage of the drive is reached.

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_found_error: The requested data was not found.

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.422.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 422

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.external_import_unsupported_app_error: The provided application is unsupported and cannot be used for an external import.

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.422.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/copy-to-drive.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.description
Get a Temporary URL for a given file

<note>
Note that it is not possible to get a directory temporary URL.
</note>

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.parameters[].schema.description
How long before this link expires, in seconds

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.400.description
Cannot get a temporary url for a directory

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.enum[]
Cannot get a temporary url for a directory

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Cannot get a temporary url for a directory

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.400.content.application/json.examples.Cannot get a temporary url for a directory.value.error.description
Cannot get a temporary url for a directory

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/temporary_url.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions.get.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions.delete.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/current.put.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions/current.put.requestBody.content.application/json.schema.properties.keep_forever.description
Indicate whether the current version should be kept forever

# paths./2/drive/{drive_id}/files/{file_id}/versions/current.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions/current.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions/current.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/current.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions/current.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions/current.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.get.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.put.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.put.requestBody.content.application/json.schema.properties.keep_forever.description
Never delete this version from version history

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.delete.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/downlo.get.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/downlo.get.description
Download file version.

<note>
Please note that this may respond a 302 to actually download the requested content.
</note>

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/downlo.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/downlo.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/downlo.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/downlo.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/downlo.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/downlo.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.tags[]
Drive > Files > File/Directory > Version

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.description
Restore a file version as a copy in target directory, keeping current original intact.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.requestBody.content.application/json.schema.properties.name.description
Name of File in the destination Directory

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/notify.post.description
Notify users mentioned in a file (OnlyOffice or native comment)

# paths./2/drive/{drive_id}/files/{file_id}/notify.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/notify.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/notify.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/notify.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/notify.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/notify.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.tags[]
Drive > Files > File/Directory > Access > Request

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.summary
Get requested file access from a file id

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.description
Show requested file access for a given file

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.tags[]
Drive > Files > File/Directory > Access > Request

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.requestBody.content.application/json.schema.properties.message.description
Message provided by the requestor of new access

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/requests.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/applications.post.requestBody.content.application/json.schema.properties.mode.description
Asked mode to open the external wopi documents.edit: Open with the edit mode. view: Open with the view mode.

# paths./2/drive/{drive_id}/files/{file_id}/access/applications.post.requestBody.content.application/json.schema.properties.type.description
List of applications.365: The 365 application. collabora: The collabora application.

# paths./2/drive/{drive_id}/files/{file_id}/access/applications.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/applications.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/applications.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/applications.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/applications.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/applications.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/access.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/access.post.parameters[].description
Override the language of the request, in most cases when an e-mail is triggered in the request.

# paths./2/drive/{drive_id}/files/{file_id}/access.post.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/files/{file_id}/access.post.requestBody.content.application/json.schema.properties.user_ids.items.description
User identifier. Only user in the same Infomaniak group

# paths./2/drive/{drive_id}/files/{file_id}/access.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.description
Retrieve the parent access rights and apply them to the current file.
Any further update on parent access rights will be propagated to this file, unless its access rights have been changed.

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/sync-parent.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.description
Analyzes each user that has access to the drive by team, email or user identifier. This method tries to find users for the given inputs:
> The emails are parsed to user identifiers if possible.
> The teams identifiers are parsed to multiple user identifiers.
> The users identifiers are parsed accordingly.

A right is required to simulate if a user needs to change their permissions to match it.

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.requestBody.content.application/json.schema.properties.user_ids.items.description
User identifier. Only user in the same Infomaniak group

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/check.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.get.tags[]
Drive > Files > File/Directory > Access > Invitation

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.get.description
Show invitation send and that has access to the File|Directory, pending and accepted invitation

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.tags[]
Drive > Files > File/Directory > Access > Invitation

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.description
Give access to the File|Directory by email

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.parameters[].description
Override the language of the request, in most cases when an e-mail is triggered in the request.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations/check.post.tags[]
Drive > Files > File/Directory > Access > Invitation

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations/check.post.description
Check if an invitation exists or a drive invitation is currently pending

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations/check.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations/check.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations/check.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations/check.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations/check.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/invitations/check.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.get.tags[]
Drive > Files > File/Directory > Access > Teams

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.get.description
Show team that has access to the File|Directory

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.tags[]
Drive > Files > File/Directory > Access > Teams

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.parameters[].description
Override the language of the request, in most cases when an e-mail is triggered in the request.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.tags[]
Drive > Files > File/Directory > Access > Teams

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.description
Update the access permission of a team access

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.tags[]
Drive > Files > File/Directory > Access > Teams

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.description
Delete the access permission of a team access

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/teams/{team_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users.get.tags[]
Drive > Files > File/Directory > Access > Users

# paths./2/drive/{drive_id}/files/{file_id}/access/users.get.description
Show user that has access to the File|Directory

# paths./2/drive/{drive_id}/files/{file_id}/access/users.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/users.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.tags[]
Drive > Files > File/Directory > Access > Users

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.parameters[].description
Override the language of the request, in most cases when an e-mail is triggered in the request.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.requestBody.content.application/json.schema.properties.user_ids.items.description
User identifier. Only user in the same Infomaniak group

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.object_not_found: Triggered when the asked entity is not accessible.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/users.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.tags[]
Drive > Files > File/Directory > Access > Users

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.description
Update the access permission of an access

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.requestBody.content.application/json.schema.properties.right.description
Access level of {name}.manage: Can share, write and read the file. none: Can not act on the file. read: Can only read the file. write: Can write and read the file.

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.delete.tags[]
Drive > Files > File/Directory > Access > Users

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/users/{user_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.tags[]
Drive > Files > File/Directory > Access > Users

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.401.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 401

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_authorized: Triggered when the user is not authorized to access this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.401.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/access/force.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/link.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/link.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/link.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/link.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/link.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link.put.requestBody.content.application/json.schema.properties.can_comment.description
Allow users to to comment the shared files. It takes the same value as can_edit if unset or null

# paths./2/drive/{drive_id}/files/{file_id}/link.put.requestBody.content.application/json.schema.properties.can_edit.description
Allow users to edit the file content using the shared link

# paths./2/drive/{drive_id}/files/{file_id}/link.put.requestBody.content.application/json.schema.properties.can_request_access.description
Allow connected users to join the folder via the shared link. It is not possible to join a file via a shared link

# paths./2/drive/{drive_id}/files/{file_id}/link.put.requestBody.content.application/json.schema.properties.can_see_info.description
Allow users to see information about the shared files

# paths./2/drive/{drive_id}/files/{file_id}/link.put.requestBody.content.application/json.schema.properties.password.description
The password if the permission password is set

# paths./2/drive/{drive_id}/files/{file_id}/link.put.requestBody.content.application/json.schema.properties.valid_until.description
Maximum validity timestamp of the shared link

# paths./2/drive/{drive_id}/files/{file_id}/link.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/link.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/link.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/link.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/link.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/link.post.requestBody.content.application/json.schema.properties.can_comment.description
Allow users to to comment the shared files. It takes the same value as can_edit if unset or null

# paths./2/drive/{drive_id}/files/{file_id}/link.post.requestBody.content.application/json.schema.properties.can_edit.description
Allow users to edit the file content using the shared link

# paths./2/drive/{drive_id}/files/{file_id}/link.post.requestBody.content.application/json.schema.properties.can_request_access.description
Allow connected users to join the folder via the shared link. It is not possible to join a file via a shared link

# paths./2/drive/{drive_id}/files/{file_id}/link.post.requestBody.content.application/json.schema.properties.can_see_info.description
Allow users to see information about the shared files

# paths./2/drive/{drive_id}/files/{file_id}/link.post.requestBody.content.application/json.schema.properties.password.description
The password if the permission password is set

# paths./2/drive/{drive_id}/files/{file_id}/link.post.requestBody.content.application/json.schema.properties.right.description
Permission of the shared link: no restriction (public), access by authenticated and authorized user (inherit) or public but protected by a password (password)

# paths./2/drive/{drive_id}/files/{file_id}/link.post.requestBody.content.application/json.schema.properties.valid_until.description
Maximum validity timestamp of the shared link

# paths./2/drive/{drive_id}/files/{file_id}/link.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/link.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/link.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/link.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/link.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/link.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/link.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/link.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/link.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link/invite.post.description
Send an email with the share link, to allow an user to upload files.

# paths./2/drive/{drive_id}/files/{file_id}/link/invite.post.requestBody.content.application/json.schema.properties.user_ids.description
List of user ids to invite by mail. Users must be in the drive's organisation 

# paths./2/drive/{drive_id}/files/{file_id}/link/invite.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/link/invite.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/link/invite.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/link/invite.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/link/invite.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/link/invite.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.get.description
Get dropbox by the directory identifier.
<note>A dropbox allows no logged users to upload files to this directory via an external dropbox link (see Drive > External Access > Dropbox).</note>

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.description
<note>A dropbox allows unauthenticated users to upload files onto the drive via a public link (see Drive > External Access > Dropbox).</note>

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.400.description
Collaborative folder already exists for file

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.enum[]
Collaborative folder already exists for file

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Collaborative folder already exists for file

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.400.content.application/json.examples.Collaborative folder already exists for file.value.error.description
Collaborative folder already exists for file

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox/invite.post.description
Send an email with the dropbox external link, to allow an user to upload files.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox/invite.post.requestBody.content.application/json.schema.properties.user_ids.description
List of user ids to invite by mail. Users must be in the drive's organisation 

# paths./2/drive/{drive_id}/files/{file_id}/dropbox/invite.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/dropbox/invite.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox/invite.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/dropbox/invite.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/dropbox/invite.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/dropbox/invite.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.tags[]
Drive > Files > File/Directory > Comment

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/files/{file_id}/comments.post.tags[]
Drive > Files > File/Directory > Comment

# paths./2/drive/{drive_id}/files/{file_id}/comments.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/comments.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/comments.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/comments.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/comments.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/comments.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.tags[]
Drive > Files > File/Directory > Comment

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.description
Retrieve reply responding to a comment on file.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.put.tags[]
Drive > Files > File/Directory > Comment

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.put.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.put.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.put.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.post.tags[]
Drive > Files > File/Directory > Comment

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.delete.tags[]
Drive > Files > File/Directory > Comment

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/like.post.tags[]
Drive > Files > File/Directory > Comment

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/like.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/like.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/like.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/like.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/like.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/like.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/unlike.post.tags[]
Drive > Files > File/Directory > Comment

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/unlike.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/unlike.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/unlike.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/unlike.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/unlike.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/{file_id}/comments/{comment_id}/unlike.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/exists.post.description
Check if some files ids still exists in the drive

# paths./2/drive/{drive_id}/files/exists.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/exists.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/exists.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/exists.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/exists.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/exists.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.description
You can download an archive/zip with the token provided by the route drive/{drive_id}/files/archives.

Please note that this may respond a 302 to actually download the requested content.

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_files_error: To many files, max limit reached.

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/files/archives/{archive_uuid}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/trash.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/trash.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/trash.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/trash.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/count.get.description
Count the number of Directory and File in trash

# paths./2/drive/{drive_id}/trash/count.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/trash/count.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/trash/count.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/count.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/trash/count.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/trash/count.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/{file_id}.delete.description
Delete a file from trash (remove it completely)

# paths./2/drive/{drive_id}/trash/{file_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/trash/{file_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/trash/{file_id}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/{file_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/trash/{file_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/trash/{file_id}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/{file_id}/restore.post.description
Restore a specific Directory or File from the trash

# paths./2/drive/{drive_id}/trash/{file_id}/restore.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/trash/{file_id}/restore.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.lock_error: Action impossible. There is a lock on the file/directory. forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/trash/{file_id}/restore.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/{file_id}/restore.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/trash/{file_id}/restore.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/trash/{file_id}/restore.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/{file_id}/thumbnail.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/trash/{file_id}/thumbnail.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/trash/{file_id}/thumbnail.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/{file_id}/thumbnail.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/trash/{file_id}/thumbnail.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/trash/{file_id}/thumbnail.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/{file_id}/count.get.summary
Count Directory/File in trashed Directory

# paths./2/drive/{drive_id}/trash/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/trash/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/trash/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/trash/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/trash/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/trash/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/upload.delete.description
Cancel an upload by its path (for instance, if the session token is unknown)

# paths./2/drive/{drive_id}/upload.delete.requestBody.content.application/json.schema.properties.directory_id.description
The directory destination root of the new file. Must be a directory.
If the identifier is unknown you can use only directory_path.
The identifier 1 is the user root folder.
Required without directory_path

# paths./2/drive/{drive_id}/upload.delete.requestBody.content.application/json.schema.properties.directory_path.description
The destination path of the new file. If the directory_id is provided the directory path is used as a relative path, otherwise it will be used as an absolute path. The destination should be a directory.
If the directory path does not exist, folders are created automatically.
The path is a destination path, the file name should not be provided at the end.
Required without directory_id.

# paths./2/drive/{drive_id}/upload.delete.requestBody.content.application/json.schema.properties.file_id.description
File identifier of uploaded file.
This is an alternative to replace a file by its identifier, if this mode is used file_name, directory_id, conflict and directory_path params are automatically computed and cannot be provided.
If you don't know the identifier, or you want to upload a new file, you should provide a filename and a directory destination.

# paths./2/drive/{drive_id}/upload.delete.requestBody.content.application/json.schema.properties.file_name.description
The name of the file to create.
                        <note>Slashes will be replaced by colons.</note>
                        <note>Maximum bytes size is 255</note>

# paths./2/drive/{drive_id}/upload.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/upload.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/upload.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/upload.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/upload.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/upload.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/upload/session/{session_token}.delete.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./2/drive/{drive_id}/upload/session/{session_token}.delete.description
Cancel an upload by its token. If you want to stop the upload and close the session to explicitly erase the file/upload.

When a session is started, it can be used for a maximum of 4 hours. It will be automatically canceled afterwards.

# paths./2/drive/{drive_id}/upload/session/{session_token}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/upload/session/{session_token}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/upload/session/{session_token}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/upload/session/{session_token}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/upload/session/{session_token}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/upload/session/{session_token}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/upload/session/batch.delete.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./2/drive/{drive_id}/upload/session/batch.delete.description
Cancel multiple session tokens. If you want to stop the upload and close one or more sessions to explicitly erase file(s)/upload(s).

When a session is started, it can be used for a maximum of 4 hours. It will be automatically canceled afterwards.
The batch cannot exceed 1,000 sessions.

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.429.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 429

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.429.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_upload_sessions_error: You have reached the maximum limit of simultaneous upload sessions. Wait before some uploads finish before retrying.

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.429.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/drive/{drive_id}/upload/session/batch.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.description
Build an archive from files in the share link. The archive can then be downloaded using the drive/{drive_id}/share/{sharelink_uuid}/download route.

The file identifiers should be in the same parent directory.
The archive should contain at least one file and may not contain more than 20,000 files.

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.requestBody.content.application/json.schema.properties.except_file_ids.description
Array of files to exclude from the request; only used when parent_id is set, meaningless otherwise

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.requestBody.content.application/json.schema.properties.file_ids.description
Array of files to include in the request; required without parent_id

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.requestBody.content.application/json.schema.properties.parent_id.description
The directory containing the files to include in the request; required without file_ids

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.file_not_in_share_link_error: The provided file or directory does not belong to the given share link.

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.description
You can download an archive/zip with the archive token provided by the route drive/{drive_id}/share/{sharelink_uuid}/download.
Please note that this may respond a 302 to actually download the requested content.

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_files_error: To many files, max limit reached.

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission.

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./2/app/{drive_id}/share/{sharelink_uuid}/archive/{archive_uuid}/.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.description
Retrieve a paginated list of files from category

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/categories/{category_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/activities.get.description
Get all activities from drive as defined in options

# paths./3/drive/{drive_id}/activities.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/activities.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/activities.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/activities.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/activities.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[created_at]=asc`

# paths./3/drive/{drive_id}/activities.get.parameters[].description
Override the language of the request, in most cases when an e-mail is triggered in the request.

# paths./3/drive/{drive_id}/activities.get.parameters[].schema.items.description
Logged interaction type of activities on the drive or file.acl_insert: Technical: when a new group access to a file/directory is create. acl_main_users_insert: Logged when the main kDrive team access to a file/directory is created. acl_main_users_remove: Logged when the main kDrive team to a file/directory is removed. acl_main_users_update: Logged when the main kDrive team to a file/directory is modified. acl_remove: Technical: when a group access to a file/directory is removed. acl_team_insert: Logged when a team access to a file/directory is created. acl_team_remove: Logged when a team access to a file/directory is removed. acl_team_update: Logged when a team access to a file/directory is modified. acl_update: Technical: when a group access to a file/directory is modified. acl_user_insert: Logged when an user/admin access to a file/directory is created. acl_user_remove: Logged when an user/admin access to a file/directory is removed. acl_user_update: Logged when an user/admin access to a file/directory is modified. category_create: Logged when a new category is added. category_delete: Logged when a category is deleted. category_update: Logged when a category is renamed. collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. exchange_pro_create: Technical: no used. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. file_update_mime_type: Logged when a file mime_type is updated. maintenance_added: Logged when a maintenance start. maintenance_removed: Logged when a maintenance ends. rewind_ended: Logged when the user ended a rewind. rewind_started: Logged when the user started a rewind. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified. trash_empty: Logged when the user empties the trash. trash_empty_auto: Logged when the trash empties old files automatically. update_trash_settings: Logged when the user changes trash the settings. user_connected: Logged when an user is connected to the drive. user_create: Logged when an user/admin is added to the drive. user_delete: Logged when an user/admin has been removed of the drive. user_restore: Logged when an user/admin has been restored of the drive. user_update: Logged when an user/admin information has changed.

# paths./3/drive/{drive_id}/activities.get.parameters[].schema.description
List of files for which to retrieve activities

# paths./3/drive/{drive_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/activities/total.get.summary
Get total count drive activities of all the users.

# paths./3/drive/{drive_id}/activities/total.get.description
Get total of all activities from drive as defined in options

# paths./3/drive/{drive_id}/activities/total.get.parameters[].schema.items.description
Logged interaction type of activities on the drive or file.acl_insert: Technical: when a new group access to a file/directory is create. acl_main_users_insert: Logged when the main kDrive team access to a file/directory is created. acl_main_users_remove: Logged when the main kDrive team to a file/directory is removed. acl_main_users_update: Logged when the main kDrive team to a file/directory is modified. acl_remove: Technical: when a group access to a file/directory is removed. acl_team_insert: Logged when a team access to a file/directory is created. acl_team_remove: Logged when a team access to a file/directory is removed. acl_team_update: Logged when a team access to a file/directory is modified. acl_update: Technical: when a group access to a file/directory is modified. acl_user_insert: Logged when an user/admin access to a file/directory is created. acl_user_remove: Logged when an user/admin access to a file/directory is removed. acl_user_update: Logged when an user/admin access to a file/directory is modified. category_create: Logged when a new category is added. category_delete: Logged when a category is deleted. category_update: Logged when a category is renamed. collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. exchange_pro_create: Technical: no used. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. file_update_mime_type: Logged when a file mime_type is updated. maintenance_added: Logged when a maintenance start. maintenance_removed: Logged when a maintenance ends. rewind_ended: Logged when the user ended a rewind. rewind_started: Logged when the user started a rewind. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified. trash_empty: Logged when the user empties the trash. trash_empty_auto: Logged when the trash empties old files automatically. update_trash_settings: Logged when the user changes trash the settings. user_connected: Logged when an user is connected to the drive. user_create: Logged when an user/admin is added to the drive. user_delete: Logged when an user/admin has been removed of the drive. user_restore: Logged when an user/admin has been restored of the drive. user_update: Logged when an user/admin information has changed.

# paths./3/drive/{drive_id}/activities/total.get.parameters[].schema.description
List of files for which to retrieve activities

# paths./3/drive/{drive_id}/activities/total.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/activities/total.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/activities/total.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/activities/total.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/activities/total.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/activities/total.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/users.get.description
Retrieves a list of users. By default, this endpoint returns all active account users. Using the types parameter, you can filter by: account, drive role, or pending invitation.
The results are filtered based on the requesting user's permissions.

# paths./3/drive/{drive_id}/users.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/users.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/users.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/users.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/users.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[display_name]=asc`

# paths./3/drive/{drive_id}/users.get.parameters[].schema.description
Search user by his first name, last name or email

# paths./3/drive/{drive_id}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/users.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/wake.post.description
Request a {@link Drive} with a {@link MaintenanceType::Asleep} maintenance to wake up.

# paths./3/drive/{drive_id}/wake.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/wake.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_not_asleep_error: Drive is not asleep.

# paths./3/drive/{drive_id}/wake.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/wake.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/wake.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/wake.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/wake.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./3/drive/{drive_id}/wake.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_wont_wake_up_error: Something went wrong while trying to wake this drive up.

# paths./3/drive/{drive_id}/wake.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/wake.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/wake.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/wake.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}.get.description
Get File/Directory by file identifier.
If you need to access the root directory, set the 'file_id' parameter to '1'; from there, you can navigate to other files and directories.

# paths./3/drive/{drive_id}/files/{file_id}.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/files.get.description
Get paginate children file/directory of specific directory (file identifier)

# paths./3/drive/{drive_id}/files/{file_id}/files.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/files.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/{file_id}/files.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/{file_id}/files.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/{file_id}/files.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/files/{file_id}/files.get.parameters[].schema.items.description
The file type structure either a File, a Directory or a Vault

# paths./3/drive/{drive_id}/files/{file_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/name.get.description
Get a sub directory or file of a Directory by their filename

# paths./3/drive/{drive_id}/files/{file_id}/name.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/name.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/name.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/name.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/name.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/name.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/name.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[created_at]=asc`

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.parameters[].schema.items.description
Logged interaction type of activities on the drive or file.collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified.

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.still_uploading_error: Cannot act on the file, the file is currently uploading.

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/hash.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/count.get.description
Get number of element in a directory by ID

# paths./3/drive/{drive_id}/files/{file_id}/count.get.parameters[].schema.description
Specifies how elements are counted within given folder. Choose either to count only within the specified folder (folder) or to include subfolders in the count (unlimited). The default mode is folder.

folder: Count elements only in the specified folder, excluding subfolders.

unlimited: Count elements in the specified folder and all subfolders.

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_a_directory_error: The provided file is not a directory.

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.description
Create directory in the specified directory (file identifier).
To know if you can create a directory inside a directory you can query
GET 3/drive/{drive_id}/files/{file}/files?with=capabilities
and look for the property `can_create_directory`
You can get your personal folder id from the route 3/drive/{drive_id}/files/1/files

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.requestBody.content.application/json.schema.properties.color.description
Color of the directory for the user creating it

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.requestBody.content.application/json.schema.properties.relative_path.description
relative path of the folder to create, from the destination directory

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.not_a_directory_error: The provided file is not a directory. invalid_file_name_error: Invalid request the file name is invalid.

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/directory.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/file.post.description
Create empty default file in the specified directory (file identifier).

# paths./3/drive/{drive_id}/files/{file_id}/file.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_file_name_error: Invalid request the file name is invalid.

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/file.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.requestBody.content.application/json.schema.properties.conflict.description
Select what to do when a file with the same name already exists. The default conflict mode is rename.

error : An error is returned without creating the file/session.

rename : Rename the new file with an available name (ex. `file.txt` to `file(3).txt`).

version : Replace the content of the existing file (create a new version of the file).

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_file_name_error: Invalid request the file name is invalid.

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/copy/{destination_directory_.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/duplicate.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/duplicate.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/duplicate.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/duplicate.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/duplicate.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/duplicate.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/duplicate.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/convert.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/convert.post.parameters[].schema.description
File password to open it for conversion, if the file is password-protected

# paths./3/drive/{drive_id}/files/{file_id}/convert.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/convert.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/convert.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/convert.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/convert.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/convert.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.description
Move a Directory or a File to a Directory

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.requestBody.content.application/json.schema.properties.conflict.description
Select what to do when a file with the same name already exists. The default conflict mode is error.

error : An error is returned without creating the file/session.

rename : Rename the new file with an available name (ex. `file.txt` to `file (3).txt`).

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_file_name_error: Invalid request the file name is invalid.

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/move/{destination_directory_.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/lock.delete.description
Unlocked File/Directory by path and token in the specified file

# paths./3/drive/{drive_id}/files/{file_id}/lock.delete.parameters[].schema.description
The lock token, provided when the file is locked

# paths./3/drive/{drive_id}/files/{file_id}/lock.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/lock.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/lock.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/lock.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/lock.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/lock.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/versions.get.tags[]
Drive > Files > File/Directory > Version

# paths./3/drive/{drive_id}/files/{file_id}/versions.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/versions.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/versions.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/versions.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/versions.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/versions.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/versions.get.x-capabilities[].description
Group a request's items in pages and define which page you want to display

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.tags[]
Drive > Files > File/Directory > Version

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.tags[]
Drive > Files > File/Directory > Version

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.description
Restore a file version as a copy in target directory, keeping current original intact.

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.requestBody.content.application/json.schema.properties.name.description
Name of File in the destination Directory

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/versions/{version_id}/restor.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.requestBody.content.application/json.schema.properties.last_modified_at.description
Override the update date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.cannot_update_object: Triggered when the entity cannot be updated.

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/{file_id}/last-modified.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search.get.description
Search files and directories with specific filters.

# paths./3/drive/{drive_id}/files/search.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[last_modified_at]=asc`

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
Category pattern, patterns accepted are ()&| and combined category ids, to manage complex computing operation :
& as synonym of AND
| as synonym of OR
() to handle priority

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
To search files recursively (use unlimited) or to search files in the first directory (use child)

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
The directory identifier, to search inside a specific directory, default is the root directory

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.items.description
A file or directory ID to scope the search

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
Array of file/directory IDs to scope the search. Mutually exclusive with directory_id. Max 100.

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
`modified_at` must be set as custom in order to use modified_after. Filter `File` modified after timestamp. Its minimum value is drive creation timestamp.

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
Modification time of the `File`.custom: Custom period from `{attribute}_after` to `{attribute}_before` params. last_12_months: Last 12 months. last_24_hours: Last 24 hours. last_30_days: Last 30 days. last_7_days: Last 7 days. last_90_days: Last 90 days. last_month: Previous month, from the first day at 00:00:00 to the last day at 23:59:59. last_week: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59. last_year: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59. this_month: Current month, from the first day at 00:00:00 to the last day at 23:59:59. this_week: Current week, from Monday at 00:00:00 to Sunday at 23:59:59. this_year: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59. today: Current day, from 00:00:00 to 23:59:59. yesterday: Previous day, from 00:00:00 to 23:59:59.

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
`modified_at` must be set as custom in order to use modified_before. Filter `File` modified before timestamp.

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
DEPRECATED - The searched pattern only in file name|example:file name

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
The searched pattern. It should be at least 3 characters long to get relevant results.

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.description
Defines the scope of the given search query.all: Content and filename. content: Content only. Available only when the Drive has the `can_use_content_search` capability. filename: Filename only. Available only when the Drive has the `can_use_content_search` capability.

# paths./3/drive/{drive_id}/files/search.get.parameters[].schema.items.description
The wanted file type.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. file: Deprecated. Use unknown instead. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# paths./3/drive/{drive_id}/files/search.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/search.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.results_set_too_large_error: Results set should not exceed 10000 elements. Invalid per_page / page attributes.

# paths./3/drive/{drive_id}/files/search.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/search.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/search.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/search.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/search.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[last_modified_at]=asc`

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
Category pattern, patterns accepted are ()&| and combined category ids, to manage complex computing operation :
& as synonym of AND
| as synonym of OR
() to handle priority

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
`created_at` must be set as custom in order to use created_after. Filter `Dropbox` created after timestamp. Its minimum value is drive creation timestamp.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
Creation time of the `Dropbox`.custom: Custom period from `{attribute}_after` to `{attribute}_before` params. last_12_months: Last 12 months. last_24_hours: Last 24 hours. last_30_days: Last 30 days. last_7_days: Last 7 days. last_90_days: Last 90 days. last_month: Previous month, from the first day at 00:00:00 to the last day at 23:59:59. last_week: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59. last_year: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59. this_month: Current month, from the first day at 00:00:00 to the last day at 23:59:59. this_week: Current week, from Monday at 00:00:00 to Sunday at 23:59:59. this_year: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59. today: Current day, from 00:00:00 to 23:59:59. yesterday: Previous day, from 00:00:00 to 23:59:59.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
`created_at` must be set as custom in order to use created_before. Filter `Dropbox` created before timestamp.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
Whether the `Dropbox` has an expiration date

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
Whether the `Dropbox` has password protection

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
`last_import_at` must be set as custom in order to use last_import_after. Filter ``Dropbox`` last imported in after timestamp. Its minimum value is drive creation timestamp.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
Last import time of the ``Dropbox``.custom: Custom period from `{attribute}_after` to `{attribute}_before` params. last_12_months: Last 12 months. last_24_hours: Last 24 hours. last_30_days: Last 30 days. last_7_days: Last 7 days. last_90_days: Last 90 days. last_month: Previous month, from the first day at 00:00:00 to the last day at 23:59:59. last_week: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59. last_year: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59. this_month: Current month, from the first day at 00:00:00 to the last day at 23:59:59. this_week: Current week, from Monday at 00:00:00 to Sunday at 23:59:59. this_year: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59. today: Current day, from 00:00:00 to 23:59:59. yesterday: Previous day, from 00:00:00 to 23:59:59.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
`last_import_at` must be set as custom in order to use last_import_before. Filter ``Dropbox`` last imported in before timestamp.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
The searched pattern. It should be at least 3 characters long to get relevant results.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.parameters[].schema.description
Defines the scope of the given search query.all: Content and filename. content: Content only. Available only when the Drive has the `can_use_content_search` capability. filename: Filename only. Available only when the Drive has the `can_use_content_search` capability.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.results_set_too_large_error: Results set should not exceed 10000 elements. Invalid per_page / page attributes.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/search/dropboxes.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[last_modified_at]=asc`

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
Category pattern, patterns accepted are ()&| and combined category ids, to manage complex computing operation :
& as synonym of AND
| as synonym of OR
() to handle priority

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
To search files recursively (use unlimited) or to search files in the first directory (use child)

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
The directory identifier, to search inside a specific directory, default is the root directory

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.items.description
A file or directory ID to scope the search

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
Array of file/directory IDs to scope the search. Mutually exclusive with directory_id. Max 100.

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
`modified_at` must be set as custom in order to use modified_after. Filter `File` modified after timestamp. Its minimum value is drive creation timestamp.

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
Modification time of the `File`.custom: Custom period from `{attribute}_after` to `{attribute}_before` params. last_12_months: Last 12 months. last_24_hours: Last 24 hours. last_30_days: Last 30 days. last_7_days: Last 7 days. last_90_days: Last 90 days. last_month: Previous month, from the first day at 00:00:00 to the last day at 23:59:59. last_week: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59. last_year: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59. this_month: Current month, from the first day at 00:00:00 to the last day at 23:59:59. this_week: Current week, from Monday at 00:00:00 to Sunday at 23:59:59. this_year: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59. today: Current day, from 00:00:00 to 23:59:59. yesterday: Previous day, from 00:00:00 to 23:59:59.

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
`modified_at` must be set as custom in order to use modified_before. Filter `File` modified before timestamp.

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
DEPRECATED - The searched pattern only in file name|example:file name

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
The searched pattern. It should be at least 3 characters long to get relevant results.

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.description
Defines the scope of the given search query.all: Content and filename. content: Content only. Available only when the Drive has the `can_use_content_search` capability. filename: Filename only. Available only when the Drive has the `can_use_content_search` capability.

# paths./3/drive/{drive_id}/files/search/favorites.get.parameters[].schema.items.description
The wanted file type.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. file: Deprecated. Use unknown instead. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.results_set_too_large_error: Results set should not exceed 10000 elements. Invalid per_page / page attributes.

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/search/favorites.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/links.get.description
Search share links with specific filters.

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[last_modified_at]=asc`

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
Category pattern, patterns accepted are ()&| and combined category ids, to manage complex computing operation :
& as synonym of AND
| as synonym of OR
() to handle priority

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
`created_at` must be set as custom in order to use created_after. Filter `Sharelink` created after timestamp. Its minimum value is drive creation timestamp.

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
Creation time of the `Sharelink`.custom: Custom period from `{attribute}_after` to `{attribute}_before` params. last_12_months: Last 12 months. last_24_hours: Last 24 hours. last_30_days: Last 30 days. last_7_days: Last 7 days. last_90_days: Last 90 days. last_month: Previous month, from the first day at 00:00:00 to the last day at 23:59:59. last_week: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59. last_year: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59. this_month: Current month, from the first day at 00:00:00 to the last day at 23:59:59. this_week: Current week, from Monday at 00:00:00 to Sunday at 23:59:59. this_year: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59. today: Current day, from 00:00:00 to 23:59:59. yesterday: Previous day, from 00:00:00 to 23:59:59.

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
`created_at` must be set as custom in order to use created_before. Filter `Sharelink` created before timestamp.

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
Whether the `Dropbox` has an expiration date

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
Whether the `Dropbox` has password protection

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
The searched pattern. It should be at least 3 characters long to get relevant results.

# paths./3/drive/{drive_id}/files/search/links.get.parameters[].schema.description
Defines the scope of the given search query.all: Content and filename. content: Content only. Available only when the Drive has the `can_use_content_search` capability. filename: Filename only. Available only when the Drive has the `can_use_content_search` capability.

# paths./3/drive/{drive_id}/files/search/links.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/search/links.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.results_set_too_large_error: Results set should not exceed 10000 elements. Invalid per_page / page attributes.

# paths./3/drive/{drive_id}/files/search/links.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/links.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/search/links.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/search/links.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/links.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/search/links.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/search/links.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.description
Search shared files with specific filters.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[last_modified_at]=asc`

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
Category pattern, patterns accepted are ()&| and combined category ids, to manage complex computing operation :
& as synonym of AND
| as synonym of OR
() to handle priority

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
To search files recursively (use unlimited) or to search files in the first directory (use child)

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
The directory identifier, to search inside a specific directory, default is the root directory

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.items.description
A file or directory ID to scope the search

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
Array of file/directory IDs to scope the search. Mutually exclusive with directory_id. Max 100.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
`modified_at` must be set as custom in order to use modified_after. Filter `File` modified after timestamp. Its minimum value is drive creation timestamp.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
Modification time of the `File`.custom: Custom period from `{attribute}_after` to `{attribute}_before` params. last_12_months: Last 12 months. last_24_hours: Last 24 hours. last_30_days: Last 30 days. last_7_days: Last 7 days. last_90_days: Last 90 days. last_month: Previous month, from the first day at 00:00:00 to the last day at 23:59:59. last_week: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59. last_year: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59. this_month: Current month, from the first day at 00:00:00 to the last day at 23:59:59. this_week: Current week, from Monday at 00:00:00 to Sunday at 23:59:59. this_year: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59. today: Current day, from 00:00:00 to 23:59:59. yesterday: Previous day, from 00:00:00 to 23:59:59.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
`modified_at` must be set as custom in order to use modified_before. Filter `File` modified before timestamp.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
DEPRECATED - The searched pattern only in file name|example:file name

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
The searched pattern. It should be at least 3 characters long to get relevant results.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.description
Defines the scope of the given search query.all: Content and filename. content: Content only. Available only when the Drive has the `can_use_content_search` capability. filename: Filename only. Available only when the Drive has the `can_use_content_search` capability.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.parameters[].schema.items.description
The wanted file type.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. file: Deprecated. Use unknown instead. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.results_set_too_large_error: Results set should not exceed 10000 elements. Invalid per_page / page attributes.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/search/shared_with_me.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/my_shared.get.description
Search my shared files with specific filters.

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[last_modified_at]=asc`

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
Category pattern, patterns accepted are ()&| and combined category ids, to manage complex computing operation :
& as synonym of AND
| as synonym of OR
() to handle priority

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
To search files recursively (use unlimited) or to search files in the first directory (use child)

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
The directory identifier, to search inside a specific directory, default is the root directory

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.items.description
A file or directory ID to scope the search

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
Array of file/directory IDs to scope the search. Mutually exclusive with directory_id. Max 100.

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
`modified_at` must be set as custom in order to use modified_after. Filter `File` modified after timestamp. Its minimum value is drive creation timestamp.

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
Modification time of the `File`.custom: Custom period from `{attribute}_after` to `{attribute}_before` params. last_12_months: Last 12 months. last_24_hours: Last 24 hours. last_30_days: Last 30 days. last_7_days: Last 7 days. last_90_days: Last 90 days. last_month: Previous month, from the first day at 00:00:00 to the last day at 23:59:59. last_week: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59. last_year: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59. this_month: Current month, from the first day at 00:00:00 to the last day at 23:59:59. this_week: Current week, from Monday at 00:00:00 to Sunday at 23:59:59. this_year: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59. today: Current day, from 00:00:00 to 23:59:59. yesterday: Previous day, from 00:00:00 to 23:59:59.

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
`modified_at` must be set as custom in order to use modified_before. Filter `File` modified before timestamp.

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
DEPRECATED - The searched pattern only in file name|example:file name

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
The searched pattern. It should be at least 3 characters long to get relevant results.

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.description
Defines the scope of the given search query.all: Content and filename. content: Content only. Available only when the Drive has the `can_use_content_search` capability. filename: Filename only. Available only when the Drive has the `can_use_content_search` capability.

# paths./3/drive/{drive_id}/files/search/my_shared.get.parameters[].schema.items.description
The wanted file type.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. file: Deprecated. Use unknown instead. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.results_set_too_large_error: Results set should not exceed 10000 elements. Invalid per_page / page attributes.

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/search/my_shared.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[last_modified_at]=asc`

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
Category pattern, patterns accepted are ()&| and combined category ids, to manage complex computing operation :
& as synonym of AND
| as synonym of OR
() to handle priority

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
`deleted_at` must be set as custom in order to use deleted_after. Filter `File` deleted after timestamp. Its minimum value is drive creation timestamp.

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
Deletion time of the `File`.custom: Custom period from `{attribute}_after` to `{attribute}_before` params. last_12_months: Last 12 months. last_24_hours: Last 24 hours. last_30_days: Last 30 days. last_7_days: Last 7 days. last_90_days: Last 90 days. last_month: Previous month, from the first day at 00:00:00 to the last day at 23:59:59. last_week: Previous week, from Monday at 00:00:00 to Sunday at 23:59:59. last_year: Previous year, from January 1st at 00:00:00 to December 31st at 23:59:59. this_month: Current month, from the first day at 00:00:00 to the last day at 23:59:59. this_week: Current week, from Monday at 00:00:00 to Sunday at 23:59:59. this_year: Current year, from January 1st at 00:00:00 to December 31st at 23:59:59. today: Current day, from 00:00:00 to 23:59:59. yesterday: Previous day, from 00:00:00 to 23:59:59.

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
`deleted_at` must be set as custom in order to use deleted_before. Filter `File` deleted before timestamp.

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
Who deleted the file, if `kind` is trash.

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
The searched pattern. It should be at least 3 characters long to get relevant results.

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.description
Defines the scope of the given search query.all: Content and filename. content: Content only. Available only when the Drive has the `can_use_content_search` capability. filename: Filename only. Available only when the Drive has the `can_use_content_search` capability.

# paths./3/drive/{drive_id}/files/search/trash.get.parameters[].schema.items.description
The wanted file type.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. file: Deprecated. Use unknown instead. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# paths./3/drive/{drive_id}/files/search/trash.get.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/files/search/trash.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.results_set_too_large_error: Results set should not exceed 10000 elements. Invalid per_page / page attributes.

# paths./3/drive/{drive_id}/files/search/trash.get.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/trash.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/search/trash.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/search/trash.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/search/trash.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/search/trash.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/search/trash.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/dropboxes.get.description
Get an array of all dropbox available in the drive.

# paths./3/drive/{drive_id}/files/dropboxes.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/dropboxes.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/dropboxes.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/dropboxes.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/dropboxes.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/files/dropboxes.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/dropboxes.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/dropboxes.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/dropboxes.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/dropboxes.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/dropboxes.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/dropboxes.post.requestBody.content.application/json.schema.properties.parent_directory_id.description
Id of the directory in which dropbox will be created

# paths./3/drive/{drive_id}/files/dropboxes.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/dropboxes.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/dropboxes.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/dropboxes.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/dropboxes.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/dropboxes.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/favorites.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/favorites.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/favorites.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/favorites.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/favorites.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/files/favorites.get.parameters[].schema.items.description
The file type structure either a File, a Directory or a Vault

# paths./3/drive/{drive_id}/files/favorites.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/favorites.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/favorites.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/favorites.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/favorites.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/favorites.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/largest.get.description
Get a paginated list of the largest files in the whole drive.

# paths./3/drive/{drive_id}/files/largest.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/largest.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/largest.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/largest.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/largest.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[size]=asc`

# paths./3/drive/{drive_id}/files/largest.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/largest.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/largest.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/largest.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/largest.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/largest.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/last_modified.get.description
Get a paginated list of files last modified in the whole drive.

# paths./3/drive/{drive_id}/files/last_modified.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/last_modified.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/last_modified.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/last_modified.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/last_modified.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[last_modified_at]=asc`

# paths./3/drive/{drive_id}/files/last_modified.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/last_modified.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/last_modified.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/last_modified.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/last_modified.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/last_modified.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/links.get.description
Get list of File|Directory that has share link

# paths./3/drive/{drive_id}/files/links.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/links.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/links.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/links.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/links.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/files/links.get.parameters[].schema.items.description
Rights required to view the share link.inherit: Share link is accessible only by users of the drive. password: Share link is public but protected by a password. public: Share link is public, no restriction set.

# paths./3/drive/{drive_id}/files/links.get.parameters[].schema.items.description
The file type structure either a File, a Directory or a Vault

# paths./3/drive/{drive_id}/files/links.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/links.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/links.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/links.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/links.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/links.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/most_versions.get.description
Get a paginated list of files most versioned in the whole drive.

# paths./3/drive/{drive_id}/files/most_versions.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/most_versions.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/most_versions.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/most_versions.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/most_versions.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[nb_version]=asc`

# paths./3/drive/{drive_id}/files/most_versions.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/most_versions.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/most_versions.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/most_versions.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/most_versions.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/most_versions.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/my_shared.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/my_shared.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/my_shared.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/my_shared.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/my_shared.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/files/my_shared.get.parameters[].schema.items.description
The file type structure either a File, a Directory or a Vault

# paths./3/drive/{drive_id}/files/my_shared.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/my_shared.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/my_shared.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/my_shared.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/my_shared.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/my_shared.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/shared_with_me.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/shared_with_me.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/shared_with_me.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/shared_with_me.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/shared_with_me.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/files/shared_with_me.get.parameters[].schema.items.description
The file type structure either a File, a Directory or a Vault

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.500.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 500

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.unexpected_error: Triggered when something unknown happens.

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.500.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/shared_with_me.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/team_directory.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/team_directory.post.requestBody.content.application/json.schema.properties.color.description
Color of the directory for the user creating it

# paths./3/drive/{drive_id}/files/team_directory.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/team_directory.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/team_directory.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/team_directory.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/team_directory.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/team_directory.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/recents.get.summary
List the most recent files or directories used by the user.

# paths./3/drive/{drive_id}/files/recents.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/recents.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/recents.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/recents.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/recents.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[updated_at]=asc`

# paths./3/drive/{drive_id}/files/recents.get.parameters[].schema.items.description
The file type structure either a Directory or a Vault

# paths./3/drive/{drive_id}/files/recents.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/recents.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/recents.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/recents.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/recents.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/recents.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/activities.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/files/activities.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/files/activities.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/files/activities.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/files/activities.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[created_at]=asc`

# paths./3/drive/{drive_id}/files/activities.get.parameters[].schema.items.description
Logged interaction type of activities on the drive or file.collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified.

# paths./3/drive/{drive_id}/files/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/activities.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/activities.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/archives.post.description
Build an archive from selected files. The archive can then be downloaded using the /2/drive/{drive_id}/files/archives/{archive_uuid} route.

The file identifiers should be in the same parent directory.
The archive should contain at least one file and may not contain more than 20,000 files.

# paths./3/drive/{drive_id}/files/archives.post.requestBody.content.application/json.schema.properties.except_file_ids.description
Array of files to exclude from the request; only used when parent_id is set, meaningless otherwise

# paths./3/drive/{drive_id}/files/archives.post.requestBody.content.application/json.schema.properties.file_ids.description
Array of files to include in the request; required without parent_id

# paths./3/drive/{drive_id}/files/archives.post.requestBody.content.application/json.schema.properties.parent_id.description
The directory containing the files to include in the request; required without file_ids

# paths./3/drive/{drive_id}/files/archives.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/files/archives.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/files/archives.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/files/archives.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/files/archives.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/files/archives.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/trash.get.description
Get list of trashed files at the root of the trash

# paths./3/drive/{drive_id}/trash.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/trash.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/trash.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/trash.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/trash.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/trash.get.parameters[].schema.items.description
The file type structure either a File, a Directory or a Vault

# paths./3/drive/{drive_id}/trash.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/trash.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/trash.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/trash.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/trash.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/trash.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/trash/{file_id}.get.description
Get information of file/Directory from trash

# paths./3/drive/{drive_id}/trash/{file_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/trash/{file_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/trash/{file_id}.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/trash/{file_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/trash/{file_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/trash/{file_id}.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.description
Get paginate sub-file/sub-directory of trashed directory

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.parameters[].schema.description
The `cursor` parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.parameters[].schema.items.description
The `order_by` parameter accepts values corresponding to the items attributes, allowing you to specify the field by which the list should be sorted

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.parameters[].schema.description
Specifies the default sorting direction for any `order_by` parameters provided

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.parameters[].schema.items.description
Specifies the sorting direction for a specific order_by, it should be used with the `order_by` key like `order_for[type]=asc`

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.parameters[].schema.items.description
The file type structure either a File, a Directory or a Vault

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/trash/{file_id}/files.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/trash/{file_id}/count.get.description
Count the number of directories and files

# paths./3/drive/{drive_id}/trash/{file_id}/count.get.parameters[].schema.description
Specifies how elements are counted within given folder. Choose either to count only within the specified folder (folder) or to include subfolders in the count (unlimited). The default mode is folder.

folder: Count elements only in the specified folder, excluding subfolders.

unlimited: Count elements in the specified folder and all subfolders.

# paths./3/drive/{drive_id}/trash/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/trash/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/trash/{file_id}/count.get.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/trash/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/trash/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/trash/{file_id}/count.get.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload.post.description
Create a new file with the contents provided in the request.

Do not use this to upload a file larger than 1GB. Instead, create an upload session and attach chunks.

# paths./3/drive/{drive_id}/upload.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
Specify a ETag (Entity tag) who is the identifier for a specific version of file.

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
Specify a client_token generated on client side, if an upload has already been made with the same token, the correspondent file will be returned.

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
Select what to do when a file with the same name already exists. The default conflict mode is error.

error : An error is returned without creating the file/session.

rename : Rename the new file with an available name (ex. `file.txt` to `file(3).txt`).

version : Replace the content of the existing file (create a new version of the file).

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
Override the creation date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
The directory destination root of the new file. Must be a directory.
If the identifier is unknown you can use only directory_path.
You can get your root private folder ID from 3/drive/{drive_id}/files/{file_id}/files.
Required without directory_path

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
The destination path of the new file. If the directory_id is provided the directory path is used as a relative path, otherwise it will be used as an absolute path. The destination should be a directory.
If the directory path does not exist, folders are created automatically.
The path is a destination path, the file name should not be provided at the end.
Required without directory_id.

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
File identifier of uploaded file.
This is an alternative to replace a file by its identifier, if this mode is used file_name, directory_id, conflict and directory_path params are automatically computed and cannot be provided.
If you don't know the identifier, or you want to upload a new file, you should provide a filename and a directory destination.

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
The name of the file to create.
                        <note>Slashes will be replaced by colons.</note>
                        <note>Maximum bytes size is 255</note>

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
Override the update date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
Specify a symbolic link target, if the upload is a symbolic link. Must be a relative path without absolute paths or parent directory traversal.

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
The hash of the content of the file. If provided and the uploaded content does not match this hash, an error will be returned. For a multi-chunk upload use the hash of the concatenation of the chunk's hashes.<note>Supported hashing algorithm: md5, sha1, sha256, sha512, xxh3, xxh32, xxh64, xxh128</note>

# paths./3/drive/{drive_id}/upload.post.parameters[].schema.description
Expected total size of the file to upload. If the uploaded content does not match this size, an error will be returned.<note>the unit of size is defined in Bytes.</note>

# paths./3/drive/{drive_id}/upload.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/upload.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.invalid_file_name_error: Invalid request the file name is invalid. upload_by_another_user_not_terminated_error: Another user upload the same file, the upload should be handle with another conflict mode or the user should wait the current upload. upload_error: Triggered when the upload did not finish, you should retry the upload. upload_failed_error: Something is wrong, the received file did not match with the expected parameters (hash, size...), the upload should be restarted. upload_not_terminated_error: Triggered when the upload did not receive all the expected chunks or the file is currently uploading.

# paths./3/drive/{drive_id}/upload.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/upload.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. upload_destination_not_writable_error: Triggered when the upload destination is a file or the user does not have the right to write on it, the upload should be retried with another destination directory. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/upload.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload.post.responses.404.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 404

# paths./3/drive/{drive_id}/upload.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.upload_destination_not_found_error: Triggered when the upload destination is unknown, the upload should be retried with another destination directory.

# paths./3/drive/{drive_id}/upload.post.responses.404.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./3/drive/{drive_id}/upload.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.file_already_exists_error: Action impossible. The file already exist.

# paths./3/drive/{drive_id}/upload.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/upload.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/upload.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/start.post.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./3/drive/{drive_id}/upload/session/start.post.description
This call creates a new upload session.
Upload session allows you to upload a single file in one or more requests (chunks). It is the only way to upload a file larger than 1GB.
The maximum size per chunk request is 1GB.
When a session is started, it can be used for a maximum of 4 hours.
To upload a chunk, you must use the ‘upload_url’ returned from this session opening call : upload/session/start.
Finally, when all the data have been sent, you should call upload/session/finish to close the session and save the file in kDrive.
If your file is small (<100MB) we recommend you to use the direct upload route to avoid multiple requests.

# paths./3/drive/{drive_id}/upload/session/start.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/upload/session/start.post.parameters[].schema.description
Specify a ETag (Entity tag) who is the identifier for a specific version of file.

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.conflict.description
Select what to do when a file with the same name already exists. The default conflict mode is error.

error : An error is returned without creating the file/session.

rename : Rename the new file with an available name (ex. `file.txt` to `file(3).txt`).

version : Replace the content of the existing file (create a new version of the file).

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.created_at.description
Override the creation date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.directory_id.description
The directory destination root of the new file. Must be a directory.
If the identifier is unknown you can use only directory_path.
You can get your root private folder ID from 3/drive/{drive_id}/files/{file_id}/files.
Required without directory_path

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.directory_path.description
The destination path of the new file. If the directory_id is provided the directory path is used as a relative path, otherwise it will be used as an absolute path. The destination should be a directory.
If the directory path does not exist, folders are created automatically.
The path is a destination path, the file name should not be provided at the end.
Required without directory_id.

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.file_id.description
File identifier of uploaded file.
This is an alternative to replace a file by its identifier, if this mode is used file_name, directory_id, conflict and directory_path params are automatically computed and cannot be provided.
If you don't know the identifier, or you want to upload a new file, you should provide a filename and a directory destination.

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.file_name.description
The name of the file to create.
                        <note>Slashes will be replaced by colons.</note>
                        <note>Maximum bytes size is 255</note>

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.last_modified_at.description
Override the update date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.total_chunks.description
The total number of chunks attached to the session.

# paths./3/drive/{drive_id}/upload/session/start.post.requestBody.content.application/json.schema.properties.total_size.description
Expected total size of the file to upload. If the uploaded content does not match this size, an error will be returned.<note>the unit of size is defined in Bytes.</note>

# paths./3/drive/{drive_id}/upload/session/start.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/upload/session/start.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.upload_error: Triggered when the upload did not finish, you should retry the upload. upload_failed_error: Something is wrong, the received file did not match with the expected parameters (hash, size...), the upload should be restarted. quota_exceeded_error: Triggered when the quota storage of the drive is reached. upload_by_another_user_not_terminated_error: Another user upload the same file, the upload should be handle with another conflict mode or the user should wait the current upload. upload_not_terminated_error: Triggered when the upload did not receive all the expected chunks or the file is currently uploading.

# paths./3/drive/{drive_id}/upload/session/start.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/start.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/upload/session/start.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.forbidden_error: Triggered when user does not have the file permission. lock_error: Action impossible. There is a lock on the file/directory. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/upload/session/start.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/start.post.responses.409.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 409

# paths./3/drive/{drive_id}/upload/session/start.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.conflict_error: Conflict detected. In the upload another conflict mode can be used to handle it. file_already_exists_error: Action impossible. The file already exist.

# paths./3/drive/{drive_id}/upload/session/start.post.responses.409.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/start.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/upload/session/start.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/upload/session/start.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch/start.post.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./3/drive/{drive_id}/upload/session/batch/start.post.description
This call creates one or more upload session(s).
Batch of upload sessions allows you to start multiple sessions for multiples files in one request. Each input request is cast in the same way of upload/session/start.

The maximum size per chunk request is 1GB.
When a session is started, it can be used for a maximum of 4 hours.
To upload a chunk, you must use the ‘upload_url’ returned from the session opening call : upload/session/start.
Finally, when all the data have been sent you should call upload/session/{session_token}/finish or (upload/session/batch/finish) to close the session(s) and save all the files in kDrive.
The batch cannot exceed 1,000 sessions.
If your file is small (<100MB) we recommend you to use the direct upload route to avoid multiple requests.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.If-Match.description
Specify a ETag (Entity tag) who is the identifier for a specific version of file.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.conflict.description
Select what to do when a file with the same name already exists. The default conflict mode is error.

error : An error is returned without creating the file/session.

rename : Rename the new file with an available name (ex. `file.txt` to `file(3).txt`).

version : Replace the content of the existing file (create a new version of the file).

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.created_at.description
Override the creation date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.directory_id.description
The directory destination root of the new file. Must be a directory.
If the identifier is unknown you can use only directory_path.
You can get your root private folder ID from 3/drive/{drive_id}/files/{file_id}/files.
Required without directory_path

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.directory_path.description
The destination path of the new file. If the directory_id is provided the directory path is used as a relative path, otherwise it will be used as an absolute path. The destination should be a directory.
If the directory path does not exist, folders are created automatically.
The path is a destination path, the file name should not be provided at the end.
Required without directory_id.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.file_id.description
File identifier of uploaded file.
This is an alternative to replace a file by its identifier, if this mode is used file_name, directory_id, conflict and directory_path params are automatically computed and cannot be provided.
If you don't know the identifier, or you want to upload a new file, you should provide a filename and a directory destination.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.file_name.description
The name of the file to create.
                        <note>Slashes will be replaced by colons.</note>
                        <note>Maximum bytes size is 255</note>

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.last_modified_at.description
Override the update date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.total_chunks.description
The total number of chunks attached to the session.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.requestBody.content.application/json.schema.properties.*.properties.total_size.description
Expected total size of the file to upload. If the uploaded content does not match this size, an error will be returned.<note>the unit of size is defined in Bytes.</note>

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.upload_destination_not_writable_error: Triggered when the upload destination is a file or the user does not have the right to write on it, the upload should be retried with another destination directory. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.429.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 429

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_upload_sessions_error: You have reached the maximum limit of simultaneous upload sessions. Wait before some uploads finish before retrying.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/upload/session/batch/start.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.description
Append more data to an upload session.

The maximum size per chunk request is 1GB.
To upload a chunk, you must use the ‘upload_url’ returned from the session opening call : upload/session/start.

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.parameters[].schema.description
The hash of the current chunk. If provided and the uploaded content does not match this hash, an error will be returned.<note>Supported hashing algorithm: md5, sha1, sha256, sha512, xxh3, xxh32, xxh64, xxh128</note>

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.parameters[].schema.description
The index of the current chunk, <note>The index start at 1</note>

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.parameters[].schema.description
The size of the current chunk, <note>the unit of size is defined in Bytes</note><note>Please note that the chunk size should be between 1000000 and 1000000000 bytes, except for the last one, which can be smaller as it is the final chunk</note>

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/upload/session/{session_token}/chunk.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.description
Finish an upload session, verify and save the uploaded data to the kDrive.<br/>

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.requestBody.content.application/json.schema.properties.created_at.description
Override the creation date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.requestBody.content.application/json.schema.properties.last_modified_at.description
Override the update date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.requestBody.content.application/json.schema.properties.total_chunk_hash.description
The hash of the content of the file. If provided and the uploaded content does not match this hash, an error will be returned. For a multi-chunk upload use the hash of the concatenation of the chunk's hashes.<note>Supported hashing algorithm: md5, sha1, sha256, sha512, xxh3, xxh32, xxh64, xxh128</note>

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.400.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 400

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.upload_error: Triggered when the upload did not finish, you should retry the upload. upload_not_terminated_error: Triggered when the upload did not receive all the expected chunks or the file is currently uploading.

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.400.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.lock_error: Action impossible. There is a lock on the file/directory. access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/upload/session/{session_token}/finish.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.description
Finish one or more upload session, verify and save the uploaded data to the kDrive.

The batch cannot exceed 1000 sessions.

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.parameters[].description
*Optional* : Allows loading additional data about a resource, which may include related resources.

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.requestBody.content.application/json.schema.properties.*.properties.created_at.description
Override the creation date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.requestBody.content.application/json.schema.properties.*.properties.last_modified_at.description
Override the update date metadata of the new file.<note>The value of this field will be capped at 24h from the current time.</note>

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.requestBody.content.application/json.schema.properties.*.properties.total_chunk_hash.description
The hash of the content of the file. If provided and the uploaded content does not match this hash, an error will be returned. For a multi-chunk upload use the hash of the concatenation of the chunk's hashes.<note>Supported hashing algorithm: md5, sha1, sha256, sha512, xxh3, xxh32, xxh64, xxh128</note>

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.429.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 429

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_upload_sessions_error: You have reached the maximum limit of simultaneous upload sessions. Wait before some uploads finish before retrying.

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.429.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/upload/session/batch/finish.post.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/{session_token}.delete.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./3/drive/{drive_id}/upload/session/{session_token}.delete.description
Cancel an upload by its token. If you want to stop the upload and close the session to explicitly erase the file/upload.

When a session is started, it can be used for a maximum of 4 hours. It will be automatically canceled afterwards.

# paths./3/drive/{drive_id}/upload/session/{session_token}.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/upload/session/{session_token}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/upload/session/{session_token}.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/{session_token}.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/upload/session/{session_token}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/upload/session/{session_token}.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch.delete.tags[]
Drive > Files > File/Directory > Upload > Session

# paths./3/drive/{drive_id}/upload/session/batch.delete.description
Cancel multiple session tokens. If you want to stop the upload and close one or more sessions to explicitly erase file(s)/upload(s).

When a session is started, it can be used for a maximum of 4 hours. It will be automatically canceled afterwards.
The batch cannot exceed 1,000 sessions.

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.403.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 403

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.access_denied: Triggered the user do not have access to this resource.

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.403.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.429.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 429

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.429.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.too_many_upload_sessions_error: You have reached the maximum limit of simultaneous upload sessions. Wait before some uploads finish before retrying.

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.429.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.503.content.application/json.schema.allOf[].properties.error.title
The error returned when the http code is 503

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.code.description
The error code returned, the description add details relative to this code.drive_is_in_maintenance_error: Drive is in maintenance.

# paths./3/drive/{drive_id}/upload/session/batch.delete.responses.503.content.application/json.schema.allOf[].properties.error.properties.description.example
Something wrong, additional information about the error code

# components.x-badges.scopes.description
We use OAuth2 to grant you access to our API. You can create an access token in your Infomaniak manager.
The token must then be provided in your request headers. For more information, see the Authentication page.

# components.x-badges.manager-user.description
Specific roles to manage the kDrive product. These roles are used to allow or restrict access to certain routes. These roles are managed via the Infomaniak manager.

Admin: Can manage drive and users without restriction.

Technical: Can manage drive without restriction.

Statistic: Can see statistics about the drive.

# components.x-badges.kdrive-user.description
Required drive role of the user, the roles are set when inviting a user to the drive, and managed in the Infomaniak Manager

Admin: Administrator of the drive, can manage the drive (files, settings) and invite others users.

User: Internal user can manage the files with the specified access.

External: External user can only access the files given to them by other users.

# components.x-badges.kdrive-file.description
Required file permission to access the route. The owner's file give specific permission to an user or to a team.

Manage: User has the write permission and can give access to the file/directory.

Write: User has the read permission and can modify the file/directory.

Read: User can only see the file/directory.

# components.schemas.afdc46e4_PlannedConference.properties.calendar_id.title
The unique identifier (ID) of the Infomaniak Calendar

# components.schemas.afdc46e4_PlannedConference.properties.calendar_id.description
The unique identifier (ID) of the Infomaniak Calendar where you want to plan the meeting. Make a GET request on https://calendar.infomaniak.com/api/pim/calendar

# components.schemas.afdc46e4_PlannedConference.properties.ending_at.description
Room settings can be deleted if this date expires. This field will be updated if event dates change in Infomaniak Calendar.

# components.schemas.afdc46e4_PlannedConferenceReturn.properties.id.title
The unique identifier (ID) of the Infomaniak room settings

# components.schemas.afdc46e4_PlannedConferenceReturn.properties.user_id.title
The unique identifier (ID) of the Infomaniak user

# components.schemas.afdc46e4_PlannedConferenceReturn.properties.event_id.title
The unique identifier (ID) of the Infomaniak Calendar event

# components.schemas.afdc46e4_PlannedConferenceReturn.properties.ending_at.description
Room settings can be deleted if this date expires. This field will be updated if event dates change in Infomaniak Calendar.

# components.schemas.afdc46e4_ConferenceOptions.properties.password.description
Required if password_enabled is true (never displayed)

# components.schemas.afdc46e4_ConferenceOptionsReturn.properties.drive_id.title
The unique identifier (ID) of the kDrive

# components.schemas.38cb7293_User.properties.create_at.description
The time in milliseconds a user was created

# components.schemas.38cb7293_User.properties.update_at.description
The time in milliseconds a user was last updated

# components.schemas.38cb7293_User.properties.delete_at.description
The time in milliseconds a user was deleted

# components.schemas.38cb7293_User.properties.terms_of_service_id.description
ID of accepted terms of service, if any. This field is not present if empty.

# components.schemas.38cb7293_User.properties.terms_of_service_create_at.description
The time in milliseconds the user accepted the terms of service

# components.schemas.38cb7293_Team.properties.create_at.description
The time in milliseconds a team was created

# components.schemas.38cb7293_Team.properties.update_at.description
The time in milliseconds a team was last updated

# components.schemas.38cb7293_Team.properties.delete_at.description
The time in milliseconds a team was deleted

# components.schemas.38cb7293_Team.properties.policy_id.description
The data retention policy to which this team has been assigned. If no such policy exists, or the caller does not have the `sysconsole_read_compliance_data_retention` permission, this field will be null.

# components.schemas.38cb7293_Channel.properties.create_at.description
The time in milliseconds a channel was created

# components.schemas.38cb7293_Channel.properties.update_at.description
The time in milliseconds a channel was last updated

# components.schemas.38cb7293_Channel.properties.delete_at.description
The time in milliseconds a channel was deleted

# components.schemas.38cb7293_Channel.properties.last_post_at.description
The time in milliseconds of the last post of a channel

# components.schemas.38cb7293_ChannelMember.properties.last_viewed_at.description
The time in milliseconds the channel was last viewed by the user

# components.schemas.38cb7293_ChannelMember.properties.last_update_at.description
The time in milliseconds the channel member was last updated

# components.schemas.38cb7293_ChannelMemberWithTeamData.allOf[].properties.team_display_name.description
The display name of the team to which this channel belongs.

# components.schemas.38cb7293_ChannelMemberWithTeamData.allOf[].properties.team_name.description
The name of the team to which this channel belongs.

# components.schemas.38cb7293_ChannelMemberWithTeamData.allOf[].properties.team_update_at.description
The time at which the team to which this channel belongs was last updated.

# components.schemas.38cb7293_ChannelWithTeamData.allOf[].properties.team_display_name.description
The display name of the team to which this channel belongs.

# components.schemas.38cb7293_ChannelWithTeamData.allOf[].properties.team_name.description
The name of the team to which this channel belongs.

# components.schemas.38cb7293_ChannelWithTeamData.allOf[].properties.team_update_at.description
The time at which the team to which this channel belongs was last updated.

# components.schemas.38cb7293_ChannelWithTeamData.allOf[].properties.policy_id.description
The data retention policy to which this team has been assigned. If no such policy exists, or the caller does not have the `sysconsole_read_compliance_data_retention` permission, this field will be null.

# components.schemas.38cb7293_Post.properties.create_at.description
The time in milliseconds a post was created

# components.schemas.38cb7293_Post.properties.update_at.description
The time in milliseconds a post was last updated

# components.schemas.38cb7293_Post.properties.delete_at.description
The time in milliseconds a post was deleted

# components.schemas.38cb7293_FileInfoList.properties.next_file_id.description
The ID of next file info. Not omitted when empty or not relevant.

# components.schemas.38cb7293_FileInfoList.properties.prev_file_id.description
The ID of previous file info. Not omitted when empty or not relevant.

# components.schemas.38cb7293_PostList.properties.next_post_id.description
The ID of next post. Not omitted when empty or not relevant.

# components.schemas.38cb7293_PostList.properties.prev_post_id.description
The ID of previous post. Not omitted when empty or not relevant.

# components.schemas.38cb7293_PostList.properties.has_next.description
Whether there are more items after this page.

# components.schemas.38cb7293_PostListWithSearchMatches.properties.matches.description
A mapping of post IDs to a list of matched terms within the post.

# components.schemas.38cb7293_PostMetadata.description
Additional information used to display a post.

# components.schemas.38cb7293_PostMetadata.properties.embeds.description
Information about content embedded in the post including OpenGraph previews, image link previews, and message attachments. This field will be null if the post does not contain embedded content.

# components.schemas.38cb7293_PostMetadata.properties.embeds.items.properties.type.description
The type of content that is embedded in this point.

# components.schemas.38cb7293_PostMetadata.properties.embeds.items.properties.url.description
The URL of the embedded content, if one exists.

# components.schemas.38cb7293_PostMetadata.properties.embeds.items.properties.data.description
Any additional information about the embedded content. Only used at this time to store OpenGraph metadata.
This field will be null for non-OpenGraph embeds.

# components.schemas.38cb7293_PostMetadata.properties.emojis.description
The custom emojis that appear in this point or have been used in reactions to this post. This field will be null if the post does not contain custom emojis.

# components.schemas.38cb7293_PostMetadata.properties.files.description
The FileInfo objects for any files attached to the post. This field will be null if the post does not have any file attachments.

# components.schemas.38cb7293_PostMetadata.properties.images.description
An object mapping the URL of an external image to an object containing the dimensions of that image. This field will be null if the post or its embedded content does not reference any external images.

# components.schemas.38cb7293_PostMetadata.properties.reactions.description
Any reactions made to this point. This field will be null if no reactions have been made to this post.

# components.schemas.38cb7293_TeamMember.properties.team_id.description
The ID of the team this member belongs to.

# components.schemas.38cb7293_TeamMember.properties.user_id.description
The ID of the user this member relates to.

# components.schemas.38cb7293_TeamMember.properties.roles.description
The complete list of roles assigned to this team member, as a space-separated list of role names, including any roles granted implicitly through permissions schemes.

# components.schemas.38cb7293_TeamMember.properties.delete_at.description
The time in milliseconds that this team member was deleted.

# components.schemas.38cb7293_TeamMember.properties.scheme_user.description
Whether this team member holds the default user role defined by the team's permissions scheme.

# components.schemas.38cb7293_TeamMember.properties.scheme_admin.description
Whether this team member holds the default admin role defined by the team's permissions scheme.

# components.schemas.38cb7293_TeamMember.properties.explicit_roles.description
The list of roles explicitly assigned to this team member, as a space separated list of role names. This list does *not* include any roles granted implicitly through permissions schemes.

# components.schemas.38cb7293_ChannelUnreadAt.properties.team_id.description
The ID of the team the channel belongs to.

# components.schemas.38cb7293_ChannelUnreadAt.properties.channel_id.description
The ID of the channel the user has access to..

# components.schemas.38cb7293_ChannelUnreadAt.properties.msg_count.description
No. of messages the user has already read.

# components.schemas.38cb7293_ChannelUnreadAt.properties.mention_count.description
No. of mentions the user has within the unread posts of the channel.

# components.schemas.38cb7293_ChannelUnreadAt.properties.last_viewed_at.description
time in milliseconds when the user last viewed the channel.

# components.schemas.38cb7293_Session.properties.create_at.description
The time in milliseconds a session was created

# components.schemas.38cb7293_Session.properties.expires_at.description
The time in milliseconds a session will expire

# components.schemas.38cb7293_Session.properties.last_activity_at.description
The time in milliseconds of the last activity of a session

# components.schemas.38cb7293_FileInfo.properties.user_id.description
The ID of the user that uploaded this file

# components.schemas.38cb7293_FileInfo.properties.post_id.description
If this file is attached to a post, the ID of that post

# components.schemas.38cb7293_FileInfo.properties.create_at.description
The time in milliseconds a file was created

# components.schemas.38cb7293_FileInfo.properties.update_at.description
The time in milliseconds a file was last updated

# components.schemas.38cb7293_FileInfo.properties.delete_at.description
The time in milliseconds a file was deleted

# components.schemas.38cb7293_FileInfo.properties.extension.description
The extension at the end of the file name

# components.schemas.38cb7293_FileInfo.properties.width.description
If this file is an image, the width of the file

# components.schemas.38cb7293_FileInfo.properties.height.description
If this file is an image, the height of the file

# components.schemas.38cb7293_FileInfo.properties.has_preview_image.description
If this file is an image, whether or not it has a preview-sized version

# components.schemas.38cb7293_Preference.properties.user_id.description
The ID of the user that owns this preference

# components.schemas.38cb7293_UserAutocomplete.properties.users.description
A list of users that are the main result of the query

# components.schemas.38cb7293_UserAutocomplete.properties.out_of_channel.description
A special case list of users returned when autocompleting in a specific channel. Omitted when empty or not relevant

# components.schemas.38cb7293_UserAutocompleteInChannel.properties.out_of_channel.description
A list of user objects not in the channel

# components.schemas.38cb7293_IncomingWebhook.properties.id.description
The unique identifier for this incoming webhook

# components.schemas.38cb7293_IncomingWebhook.properties.create_at.description
The time in milliseconds a incoming webhook was created

# components.schemas.38cb7293_IncomingWebhook.properties.update_at.description
The time in milliseconds a incoming webhook was last updated

# components.schemas.38cb7293_IncomingWebhook.properties.delete_at.description
The time in milliseconds a incoming webhook was deleted

# components.schemas.38cb7293_IncomingWebhook.properties.channel_id.description
The ID of a public channel or private group that receives the webhook payloads

# components.schemas.38cb7293_IncomingWebhook.properties.description.description
The description for this incoming webhook

# components.schemas.38cb7293_IncomingWebhook.properties.display_name.description
The display name for this incoming webhook

# components.schemas.38cb7293_OutgoingWebhook.properties.id.description
The unique identifier for this outgoing webhook

# components.schemas.38cb7293_OutgoingWebhook.properties.create_at.description
The time in milliseconds a outgoing webhook was created

# components.schemas.38cb7293_OutgoingWebhook.properties.update_at.description
The time in milliseconds a outgoing webhook was last updated

# components.schemas.38cb7293_OutgoingWebhook.properties.delete_at.description
The time in milliseconds a outgoing webhook was deleted

# components.schemas.38cb7293_OutgoingWebhook.properties.creator_id.description
The Id of the user who created the webhook

# components.schemas.38cb7293_OutgoingWebhook.properties.team_id.description
The ID of the team that the webhook watchs

# components.schemas.38cb7293_OutgoingWebhook.properties.channel_id.description
The ID of a public channel that the webhook watchs

# components.schemas.38cb7293_OutgoingWebhook.properties.description.description
The description for this outgoing webhook

# components.schemas.38cb7293_OutgoingWebhook.properties.display_name.description
The display name for this outgoing webhook

# components.schemas.38cb7293_OutgoingWebhook.properties.trigger_words.description
List of words for the webhook to trigger on

# components.schemas.38cb7293_OutgoingWebhook.properties.trigger_when.description
When to trigger the webhook, `0` when a trigger word is present at all and `1` if the message starts with a trigger word

# components.schemas.38cb7293_OutgoingWebhook.properties.callback_urls.description
The URLs to POST the payloads to when the webhook is triggered

# components.schemas.38cb7293_OutgoingWebhook.properties.content_type.description
The format to POST the data in, either `application/json` or `application/x-www-form-urlencoded`

# components.schemas.38cb7293_Reaction.properties.user_id.description
The ID of the user that made this reaction

# components.schemas.38cb7293_Reaction.properties.post_id.description
The ID of the post to which this reaction was made

# components.schemas.38cb7293_Reaction.properties.emoji_name.description
The name of the emoji that was used for this reaction

# components.schemas.38cb7293_Reaction.properties.create_at.description
The time in milliseconds this reaction was made

# components.schemas.38cb7293_TopReaction.properties.emoji_name.description
The name of the emoji used for this reaction.

# components.schemas.38cb7293_TopReaction.properties.count.description
The number of the times this emoji has been used.

# components.schemas.38cb7293_NewTeamMember.properties.create_at.description
The creation timestamp of the team member record.

# components.schemas.38cb7293_TopReactionList.properties.has_next.description
Indicates if there is another page of reactions that can be fetched.

# components.schemas.38cb7293_NewTeamMembersList.properties.has_next.description
Indicates if there is another page of new team members that can be fetched.

# components.schemas.38cb7293_NewTeamMembersList.properties.total_count.description
The total count of new team members for the given time range.

# components.schemas.38cb7293_TopChannel.properties.message_count.description
The number of messages posted in the channel by users over the given time period (not including messages posted by bots).

# components.schemas.38cb7293_TopChannelList.properties.has_next.description
Indicates if there is another page of channels that can be fetched.

# components.schemas.38cb7293_TopThreadList.properties.has_next.description
Indicates if there is another page of top threads that can be fetched.

# components.schemas.38cb7293_TopDMList.properties.has_next.description
Indicates if there is another page of top DMs that can be fetched.

# components.schemas.38cb7293_Emoji.properties.create_at.description
The time in milliseconds the emoji was made

# components.schemas.38cb7293_Emoji.properties.update_at.description
The time in milliseconds the emoji was last updated

# components.schemas.38cb7293_Emoji.properties.delete_at.description
The time in milliseconds the emoji was deleted

# components.schemas.38cb7293_Command.properties.token.description
The token which is used to verify the source of the payload

# components.schemas.38cb7293_Command.properties.create_at.description
The time in milliseconds the command was created

# components.schemas.38cb7293_Command.properties.update_at.description
The time in milliseconds the command was last updated

# components.schemas.38cb7293_Command.properties.delete_at.description
The time in milliseconds the command was deleted, 0 if never deleted

# components.schemas.38cb7293_Command.properties.team_id.description
The team id for which this command is configured

# components.schemas.38cb7293_Command.properties.method.description
Is the trigger done with HTTP Get ('G') or HTTP Post ('P')

# components.schemas.38cb7293_Command.properties.username.description
What is the username for the response post

# components.schemas.38cb7293_Command.properties.icon_url.description
The url to find the icon for this users avatar

# components.schemas.38cb7293_Command.properties.auto_complete_desc.description
The description for this command shown when selecting the command

# components.schemas.38cb7293_CommandResponse.properties.ResponseType.description
The response type either in_channel or ephemeral

# components.schemas.38cb7293_SlackAttachment.properties.Timestamp.description
The timestamp of the slack attachment, either type of string or integer

# components.schemas.38cb7293_SlackAttachmentField.properties.Value.description
The value of the attachment, set as string but capable with golang interface

# components.schemas.38cb7293_StatusOK.properties.status.description
Will contain "ok" if the request was successful and there was nothing else to return

# components.schemas.38cb7293_OpenGraph.properties.images.items.description
Image object used in OpenGraph metadata of a webpage

# components.schemas.38cb7293_OpenGraph.properties.videos.items.description
Video object used in OpenGraph metadata of a webpage

# components.schemas.38cb7293_OpenGraph.properties.audios.items.description
Audio object used in OpenGraph metadata of a webpage

# components.schemas.38cb7293_OpenGraph.properties.article.description
Article object used in OpenGraph metadata of a webpage, if type is article

# components.schemas.38cb7293_OpenGraph.properties.book.description
Book object used in OpenGraph metadata of a webpage, if type is book

# components.schemas.38cb7293_UserNotifyProps.properties.email.description
Set to "true" to enable email notifications, "false" to disable. Defaults to "true".

# components.schemas.38cb7293_UserNotifyProps.properties.push.description
Set to "all" to receive push notifications for all activity, "mention" for mentions and direct messages only, and "none" to disable. Defaults to "mention".

# components.schemas.38cb7293_UserNotifyProps.properties.desktop.description
Set to "all" to receive desktop notifications for all activity, "mention" for mentions and direct messages only, and "none" to disable. Defaults to "all".

# components.schemas.38cb7293_UserNotifyProps.properties.desktop_sound.description
Set to "true" to enable sound on desktop notifications, "false" to disable. Defaults to "true".

# components.schemas.38cb7293_UserNotifyProps.properties.mention_keys.description
A comma-separated list of words to count as mentions. Defaults to username and @username.

# components.schemas.38cb7293_UserNotifyProps.properties.channel.description
Set to "true" to enable channel-wide notifications (@channel, @all, etc.), "false" to disable. Defaults to "true".

# components.schemas.38cb7293_UserNotifyProps.properties.first_name.description
Set to "true" to enable mentions for first name. Defaults to "true" if a first name is set, "false" otherwise.

# components.schemas.38cb7293_Timezone.properties.useAutomaticTimezone.description
Set to "true" to use the browser/system timezone, "false" to set manually. Defaults to "true".

# components.schemas.38cb7293_Timezone.properties.manualTimezone.description
Value when setting manually the timezone, i.e. "Europe/Berlin".

# components.schemas.38cb7293_Timezone.properties.automaticTimezone.description
This value is set automatically when the "useAutomaticTimezone" is set to "true".

# components.schemas.38cb7293_ChannelNotifyProps.properties.email.description
Set to "true" to enable email notifications, "false" to disable, or "default" to use the global user notification setting.

# components.schemas.38cb7293_ChannelNotifyProps.properties.push.description
Set to "all" to receive push notifications for all activity, "mention" for mentions and direct messages only, "none" to disable, or "default" to use the global user notification setting.

# components.schemas.38cb7293_ChannelNotifyProps.properties.desktop.description
Set to "all" to receive desktop notifications for all activity, "mention" for mentions and direct messages only, "none" to disable, or "default" to use the global user notification setting.

# components.schemas.38cb7293_ChannelNotifyProps.properties.mark_unread.description
Set to "all" to mark the channel unread for any new message, "mention" to mark unread for new mentions only. Defaults to "all".

# components.schemas.38cb7293_PluginStatus.properties.plugin_id.description
Globally unique identifier that represents the plugin.

# components.schemas.38cb7293_PluginStatus.properties.description.description
Description of what the plugin is and does.

# components.schemas.38cb7293_PluginStatus.properties.cluster_id.description
ID of the cluster in which plugin is running

# components.schemas.38cb7293_Role.properties.name.description
The unique name of the role, used when assigning roles to users/groups in contexts.

# components.schemas.38cb7293_Role.properties.description.description
A human readable description of the role.

# components.schemas.38cb7293_Role.properties.permissions.description
A list of the unique names of the permissions this role grants.

# components.schemas.38cb7293_Role.properties.scheme_managed.description
indicates if this role is managed by a scheme (true), or is a custom stand-alone role (false).

# components.schemas.38cb7293_Scheme.properties.description.description
A human readable description of the scheme.

# components.schemas.38cb7293_Scheme.properties.create_at.description
The time at which the scheme was created.

# components.schemas.38cb7293_Scheme.properties.update_at.description
The time at which the scheme was last updated.

# components.schemas.38cb7293_Scheme.properties.delete_at.description
The time at which the scheme was deleted.

# components.schemas.38cb7293_Scheme.properties.scope.description
The scope to which this scheme can be applied, either "team" or "channel".

# components.schemas.38cb7293_Scheme.properties.default_team_admin_role.description
The id of the default team admin role for this scheme.

# components.schemas.38cb7293_Scheme.properties.default_team_user_role.description
The id of the default team user role for this scheme.

# components.schemas.38cb7293_Scheme.properties.default_channel_admin_role.description
The id of the default channel admin role for this scheme.

# components.schemas.38cb7293_Scheme.properties.default_channel_user_role.description
The id of the default channel user role for this scheme.

# components.schemas.38cb7293_ChannelMemberCountByGroup.description
An object describing group member information in a channel

# components.schemas.38cb7293_ChannelMemberCountByGroup.properties.channel_member_count.description
Total number of group members in the channel

# components.schemas.38cb7293_ChannelMemberCountByGroup.properties.channel_member_timezones_count.description
Total number of unique timezones for the group members in the channel

# components.schemas.38cb7293_SidebarCategoryWithChannels.description
User's sidebar category with it's channels

# components.schemas.38cb7293_OrderedSidebarCategories.description
List of user's categories with their channels

# components.schemas.38cb7293_Bot.properties.user_id.description
The user id of the associated user entry.

# components.schemas.38cb7293_Bot.properties.create_at.description
The time in milliseconds a bot was created

# components.schemas.38cb7293_Bot.properties.update_at.description
The time in milliseconds a bot was last updated

# components.schemas.38cb7293_Bot.properties.delete_at.description
The time in milliseconds a bot was deleted

# components.schemas.38cb7293_Bot.properties.owner_id.description
The user id of the user that currently owns this bot.

# components.schemas.38cb7293_GroupWithSchemeAdmin.description
group augmented with scheme admin information

# components.schemas.38cb7293_GroupsAssociatedToChannels.description
a map of channel id(s) to the set of groups that constrain the corresponding channel in a team

# components.schemas.38cb7293_UserThread.properties.id.description
ID of the post that is this thread's root

# components.schemas.38cb7293_UserThread.properties.last_reply_at.description
timestamp of the last post to this thread

# components.schemas.38cb7293_UserThread.properties.last_viewed_at.description
timestamp of the last time the user viewed this thread

# components.schemas.38cb7293_UserThread.properties.participants.description
list of users participating in this thread. only includes IDs unless 'extended' was set to 'true'

# components.schemas.38cb7293_UserThreads.properties.total.description
Total number of threads (used for paging)

# components.schemas.38cb7293_Error.properties.details.description
Further details on where and why this error happened.

# components.schemas.38cb7293_Error.properties.details.example
Specific details about the error, depending on the case.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.echo.description
If true, the new message will be prepended with the last message if they belong to the same role.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.add_generation_prompt.description
If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.continue_final_message.description
If this is set, the chat will be formatted so that the final message in the chat is open-ended, without any EOS tokens. The model will continue this message rather than starting a new one. This allows you to "prefill" part of the model's response for it. Cannot be used at the same time as `add_generation_prompt`.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.add_special_tokens.description
If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to false (as is the default).

# components.schemas.3e081f3c_ChatCompletionRequest.properties.documents.description
A list of dicts representing documents that will be accessible to the model if it is performing RAG (retrieval-augmented generation). If the template does not support RAG, this argument will have no effect. We recommend that each document should be a dict containing "title" and "text" keys.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.chat_template.description
A Jinja template to use for this conversion. As of transformers v4.44, default chat template is no longer allowed, so you must provide a chat template if the tokenizer does not define one.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.chat_template_kwargs.description
Additional kwargs to pass to the template renderer. Will be accessible by the chat template.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.mm_processor_kwargs.description
Additional kwargs to pass to the HF processor.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.guided_json.description
If specified, the output will follow the JSON schema.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.guided_regex.description
If specified, the output will follow the regex pattern.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.guided_choice.description
If specified, the output will be exactly one of the choices.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.guided_grammar.description
If specified, the output will follow the context free grammar.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.structural_tag.description
If specified, the output will follow the structural tag schema.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.guided_decoding_backend.description
If specified, will override the default guided decoding backend of the server for this specific request. If set, must be either 'outlines' / 'lm-format-enforcer'

# components.schemas.3e081f3c_ChatCompletionRequest.properties.guided_whitespace_pattern.description
If specified, will override the default whitespace pattern for guided json decoding.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.priority.description
The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.request_id.description
The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.logits_processors.description
A list of either qualified names of logits processors, or constructor objects, to apply when sampling. A constructor is a JSON object with a required 'qualname' field specifying the qualified name of the processor class/factory, and optional 'args' and 'kwargs' fields containing positional and keyword arguments. For example: {'qualname': 'my_module.MyLogitsProcessor', 'args': [1, 2], 'kwargs': {'param': 'value'}}.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.return_tokens_as_token_ids.description
If specified with 'logprobs', tokens are represented  as strings of the form 'token_id:{token_id}' so that tokens that are not JSON-encodable can be identified.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.cache_salt.description
If specified, the prefix cache will be salted with the provided string to prevent an attacker to guess prompts in multi-user environments. The salt should be random, protected from access by 3rd parties, and long enough to be unpredictable (e.g., 43 characters base64-encoded, corresponding to 256 bit). Not supported by vLLM engine V0.

# components.schemas.3e081f3c_ChatCompletionRequest.properties.kv_transfer_params.description
KVTransfer parameters used for disaggregated serving.

# components.schemas.3e081f3c_CustomChatCompletionContentSimpleAudioParam.description
A simpler version of the param that only accepts a plain audio_url.

Example:
{
    "audio_url": "https://example.com/audio.mp3"
}

# components.schemas.3e081f3c_CustomChatCompletionContentSimpleImageParam.description
A simpler version of the param that only accepts a plain image_url.
This is supported by OpenAI API, although it is not documented.

Example:
{
    "image_url": "https://example.com/image.jpg"
}

# components.schemas.3e081f3c_CustomChatCompletionContentSimpleVideoParam.description
A simpler version of the param that only accepts a plain audio_url.

Example:
{
    "video_url": "https://example.com/video.mp4"
}

# components.schemas.3e081f3c_CustomChatCompletionMessageParam.description
Enables custom roles in the Chat Completion API.

# components.schemas.Pagination.properties.total.description
Total number of items
Added when using query parameter `page`

# components.schemas.Pagination.properties.page.description
Number of the current page
Added when using query parameter `page`

# components.schemas.Pagination.properties.pages.description
Total number of pages
Added when using query parameter `page`

# components.schemas.Pagination.properties.items_per_page.description
Number of items per page
Added when using query parameter `page`

# components.schemas.1527df96_ProductExcerpt.properties.id.description
The unique identifier of the Product Excerpt

# components.schemas.1527df96_ProductExcerpt.properties.unique_id.description
The identifier of the `unique` resource related to Product Excerpt

# components.schemas.1527df96_ProductExcerpt.properties.pack.description
The pack associated with the Product Excerpt

# components.schemas.1527df96_ProductExcerpt.properties.pack_description.description
Pack description for the Product Excerpt

# components.schemas.1527df96_ProductExcerpt.properties.pack_description.example
Pour démarrer avec toutes les fonctionnalités

# components.schemas.1527df96_ProductExcerpt.properties.media_count.description
The total count of media associated with the Product Excerpt

# components.schemas.1527df96_ProductExcerpt.properties.expired_at.description
The date and time when the Product Excerpt was expired

# components.schemas.1527df96_ProductExcerpt.properties.real_expired_at.description
The actual expiration date of the Product Excerpt

# components.schemas.1527df96_ProductExcerpt.properties.tags.description
The tags associated with the Product Excerpt

# components.schemas.1527df96_Tag.properties.product_count.description
Product count related to the resource Tag

# components.schemas.1527df96_Product.properties.account_id.description
The identifier of the `account` resource related to Product

# components.schemas.1527df96_Product.properties.service_id.description
The identifier of the `service` resource related to Product

# components.schemas.1527df96_Product.properties.created_at.description
The date and time when the Product was created

# components.schemas.1527df96_Product.properties.expired_at.description
The date and time when the Product was expired

# components.schemas.1527df96_Product.properties.deleted_at.description
The date and time when the Product was deleted

# components.schemas.1527df96_Product.properties.has_maintenance.description
Does the resource Product have a maintenance mode enabled

# components.schemas.1527df96_Product.properties.has_operation_in_progress.description
Does the resource Product have an operation in progress

# components.schemas.1527df96_Product.properties.unique_id.description
The identifier of the `unique` resource related to Product

# components.schemas.1527df96_Product.properties.bill_reference.description
The reference number associated with the invoice

# components.schemas.1527df96_Product.properties.is_zero_price.description
Does the resource Product have a zero price status

# components.schemas.1527df96_Product.properties.is_trial.description
Does the resource Product have a trial status

# components.schemas.1527df96_Product.properties.parent_id.description
The identifier of the `parent` resource related to Product

# components.schemas.1527df96_Product.properties.parent_service_id.description
The ID of the parent service for the Product

# components.schemas.1527df96_Product.properties.parent_service_name.description
The name of the parent service for the Product

# components.schemas.1527df96_Product.properties.fqdn.description
Fully qualified domain name of the Product

# components.schemas.1527df96_Product.properties.ftp_prefix.description
The FTP prefix associated with the Product

# components.schemas.1527df96_Product.properties.media_count.description
The total count of media associated with the Product

# components.schemas.1527df96_Product.properties.media_imported_count.description
The count of imported media associated with the Product

# components.schemas.1527df96_Product.properties.media_imported_last_hour_count.description
The count of media imported in the last hour

# components.schemas.1527df96_Product.properties.auto_empty_trash.description
Indicates whether the trash is automatically emptied for the Product

# components.schemas.1527df96_Product.properties.role.description
Product roleautodj: Channel created for autodj usage hosting: Channel created for hosting usage video: Channel created for video usage

# components.schemas.1527df96_Product.properties.suspended_at.description
The date and time when the Product was suspended

# components.schemas.1527df96_Product.properties.legacy_product_id.description
The ID of the legacy product associated with the Product

# components.schemas.1527df96_Product.properties.real_expired_at.description
The actual expiration date of the Product

# components.schemas.1527df96_ProductUser.properties.user_id.description
The identifier of the `user` resource related to ProductUser

# components.schemas.1527df96_ProductAdminUser.properties.user_id.description
The identifier of the `user` resource related to ProductAdminUser

# components.schemas.1527df96_Relation.properties.created_at.description
The date and time when the Relation was created

# components.schemas.1527df96_Channelparameters.properties.quota.description
The allocated storage quota in bytes for the Channel parameters

# components.schemas.1527df96_Channelparameters.properties.invoice_periodicity.description
The frequency at which invoices are generated, such as monthly or annually

# components.schemas.1527df96_Channelparameters.properties.max_audio_bitrate.description
The maximum allowed audio bitrate allowed for the Channel parameters

# components.schemas.1527df96_Channelparameters.properties.max_video_bitrate.description
The maximum allowed video bitrate allowed for the Channel parameters

# components.schemas.1527df96_Channelparameters.properties.max_imports.description
The maximum number of imports allowed for the Channel parameters

# components.schemas.1527df96_Channelparameters.properties.debug_encode.description
A flag indicating whether debug mode is enabled for encoding processes

# components.schemas.1527df96_Channelparameters.properties.os_swift_template.description
The template used for OpenStack Swift integration

# components.schemas.1527df96_Channelparameters.properties.v1_compat.description
A flag indicating compatibility with version 1 of the service

# components.schemas.1527df96_Channelparameters.properties.v1_compat_callback.description
A flag indicating compatibility with version 1 of callback functions

# components.schemas.1527df96_Channelparameters.properties.v1_compat_ftp.description
A flag indicating compatibility with version 1 of FTP services

# components.schemas.1527df96_Channelparameters.properties.v1_compat_soap_api.description
A flag indicating compatibility with version 1 of the SOAP API

# components.schemas.1527df96_Callback.properties.channel_id.description
The identifier of the `channel` resource related to Callback

# components.schemas.1527df96_Callback.properties.auth.description
The authentication method of the Callback

# components.schemas.1527df96_Callback.properties.basic_username.description
The basic authentication username of the Callback

# components.schemas.1527df96_Callback.properties.basic_password.description
The basic authentication password of the Callback

# components.schemas.1527df96_Callback.properties.active.description
Indicates whether the Callback is active

# components.schemas.1527df96_Callback.properties.created_at.description
The date and time when the Callback was created

# components.schemas.1527df96_Callback.properties.updated_at.description
The date and time when the Callback was updated

# components.schemas.1527df96_Callback.properties.deleted_at.description
The date and time when the Callback was deleted

# components.schemas.1527df96_File.properties.type.items.description
folder: Folder model file: File model

# components.schemas.1527df96_File.properties.type.description
folder: Folder model file: File model

# components.schemas.1527df96_File.properties.parent_id.description
The identifier of the `parent` resource related to File

# components.schemas.1527df96_File.properties.channel_id.description
The identifier of the `channel` resource related to File

# components.schemas.1527df96_File.properties.published.description
Indicates whether the File is publicly accessible

# components.schemas.1527df96_File.properties.has_password.description
Indicates whether the File has a password

# components.schemas.1527df96_File.properties.is_shareable.description
Indicates whether the File can be shared publicly

# components.schemas.1527df96_File.properties.media_types.items.description
File video streams (only applies to media)audio: Media has an audio stream video: Media has a video stream

# components.schemas.1527df96_File.properties.media_types.description
File video streams (only applies to media)audio: Media has an audio stream video: Media has a video stream

# components.schemas.1527df96_File.properties.folders_count.description
The number of folders associated with the File

# components.schemas.1527df96_File.properties.files_count.description
The number of files associated with the File

# components.schemas.1527df96_File.properties.state.items.description
Contains information about media encoding status and availability.idle: Media has nothing going on deleted: Media is deleted transferring: Media upload is in progress: transferring from the remote source initializing: Media is initializing: bootstrapping and doing pre-flight checks await_encoding: No encodings are available for the current media encoding: Media has at least one encoding in progress available: Media can be displayed on a video player ready: Media is ready: all encodings & thumbnails have been processed e_transient: Media is experiencing a transient error e_fatal: Something is gone wrong

# components.schemas.1527df96_File.properties.state.description
Contains information about media encoding status and availability.idle: Media has nothing going on deleted: Media is deleted transferring: Media upload is in progress: transferring from the remote source initializing: Media is initializing: bootstrapping and doing pre-flight checks await_encoding: No encodings are available for the current media encoding: Media has at least one encoding in progress available: Media can be displayed on a video player ready: Media is ready: all encodings & thumbnails have been processed e_transient: Media is experiencing a transient error e_fatal: Something is gone wrong

# components.schemas.1527df96_File.properties.created_at.description
The date and time when the File was created

# components.schemas.1527df96_File.properties.updated_at.description
The date and time when the File was updated

# components.schemas.1527df96_File.properties.discarded_at.description
The date and time when the File was discarded

# components.schemas.1527df96_Mediathumbnailslinks.properties.image.description
The image associated with Media thumbnails links

# components.schemas.1527df96_Mediathumbnailslinks.properties.audio_sample.description
Audio file containing an excerpt of the media (audio only)

# components.schemas.1527df96_Mediathumbnailslinks.properties.video_sample.description
`1xN` low res spritemap of the media containing an image per second

# components.schemas.1527df96_Mediathumbnailslinks.properties.thumbstrip.description
10x300 medium res spritemap of the media containing an image per second

# components.schemas.1527df96_Mediathumbnailslinks.properties.scenes.description
10x300 medium res spritemap of the media containing an image for each scene change

# components.schemas.1527df96_Mediathumbnailslinks.properties.poster.description
High res thumbnail image, may be used for user integration

# components.schemas.1527df96_FileExcerpt.properties.id.description
The unique identifier of the File Excerpt

# components.schemas.1527df96_FileExcerpt.properties.type.items.description
folder: Folder model file: File model

# components.schemas.1527df96_FileExcerpt.properties.type.description
folder: Folder model file: File model

# components.schemas.1527df96_FileExcerpt.properties.streams.items.description
File Excerpt streams (only applies to media)audio: Media has an audio stream video: Media has a video stream

# components.schemas.1527df96_FileExcerpt.properties.streams.description
File Excerpt streams (only applies to media)audio: Media has an audio stream video: Media has a video stream

# components.schemas.1527df96_Country.properties.alpha3.description
The three-letter country code (ISO 3166-1 alpha-3) of the country

# components.schemas.1527df96_Language.properties.endonym.description
The endonym of the language (local language name)

# components.schemas.1527df96_Language.properties.endonym.example
беларуская мова

# components.schemas.1527df96_Alert.properties.channel_id.description
The identifier of the `channel` resource related to Alert

# components.schemas.1527df96_Alert.properties.transports.items.description
Alert transportsphone: Send notifications by phone email: Send notifications by email

# components.schemas.1527df96_Alert.properties.transports.description
Alert transportsphone: Send notifications by phone email: Send notifications by email

# components.schemas.1527df96_Alert.properties.days.items.description
Alert daysmonday: tuesday: wednesday: thursday: friday: saturday: sunday:

# components.schemas.1527df96_Alert.properties.days.description
Alert daysmonday: tuesday: wednesday: thursday: friday: saturday: sunday:

# components.schemas.1527df96_Alert.properties.created_at.description
The date and time when the Alert was created

# components.schemas.1527df96_Alert.properties.updated_at.description
The date and time when the Alert was updated

# components.schemas.1527df96_User.properties.channel_id.description
The identifier of the `channel` resource related to User

# components.schemas.1527df96_User.properties.permissions.items.description
User permissionscwd: Change Working Directory (navigate to a different directory)list: List files and directories in the current directory retr: Retrieve (download) a file from the server appe: Append data to an existing file on the server dele: Delete a file on the server rnfr: Rename From (specify the original name when renaming a file)mkd: Make Directory (create a new directory)stor: Store (upload) a file to the server chmod: Change the permissions of a file or directory mfmt: Modify the modification time of a file

# components.schemas.1527df96_User.properties.permissions.description
User permissionscwd: Change Working Directory (navigate to a different directory)list: List files and directories in the current directory retr: Retrieve (download) a file from the server appe: Append data to an existing file on the server dele: Delete a file on the server rnfr: Rename From (specify the original name when renaming a file)mkd: Make Directory (create a new directory)stor: Store (upload) a file to the server chmod: Change the permissions of a file or directory mfmt: Modify the modification time of a file

# components.schemas.1527df96_User.properties.created_at.description
The date and time when the User was created

# components.schemas.1527df96_User.properties.updated_at.description
The date and time when the User was updated

# components.schemas.1527df96_Player.properties.auto_hide_controls.description
Indicates whether controls should automatically hide for the Player

# components.schemas.1527df96_Player.properties.auto_start.description
Indicates whether media should start automatically for the Player

# components.schemas.1527df96_Player.properties.chromecast.description
Indicates whether Chromecast is enabled for the Player

# components.schemas.1527df96_Player.properties.default_speed.description
The default speed of playback for the Player

# components.schemas.1527df96_Player.properties.enable_embed_code.description
Indicates whether embed code is enabled for the Player

# components.schemas.1527df96_Player.properties.enable_facebook.description
Indicates whether Facebook sharing is enabled for the Player

# components.schemas.1527df96_Player.properties.enable_twitter.description
Indicates whether Twitter sharing is enabled for the Player

# components.schemas.1527df96_Player.properties.encoding_change_enabled.description
Indicates whether encoding change is enabled for the Player

# components.schemas.1527df96_Player.properties.facebook_back_link.description
The back link for Facebook sharing associated with the Player

# components.schemas.1527df96_Player.properties.force_media_ratio.description
Indicates whether media ratio is enforced for the Player

# components.schemas.1527df96_Player.properties.is360.description
Indicates whether the Player supports 360-degree videos

# components.schemas.1527df96_Player.properties.logo_margin_horizontal.description
The horizontal margin of the Player logo

# components.schemas.1527df96_Player.properties.media_thumbnail_anchor.description
The anchor position of the Player thumbnail

# components.schemas.1527df96_Player.properties.player_end_screen_type.description
The selected kind of player ending screen

# components.schemas.1527df96_Player.properties.preferred_playback_strategy.description
The preferred playback strategy for the Player: may not be satisfied

# components.schemas.1527df96_Player.properties.show_audio.description
Indicates whether audio controls should be shown for the Player

# components.schemas.1527df96_Player.properties.show_controls.description
Indicates whether controls should be shown for the Player

# components.schemas.1527df96_Player.properties.show_default_logo.description
Indicates whether the default logo should be shown for the Player

# components.schemas.1527df96_Player.properties.show_duration.description
Indicates whether the duration should be shown for the Player

# components.schemas.1527df96_Player.properties.show_fullscreen.description
Indicates whether fullscreen controls should be shown for the Player

# components.schemas.1527df96_Player.properties.show_loop.description
Indicates whether loop controls should be shown for the Player

# components.schemas.1527df96_Player.properties.show_media_info.description
Indicates whether media information should be shown for the Player

# components.schemas.1527df96_Player.properties.show_media_thumbnail.description
Indicates whether media thumbnail should be shown for the Player

# components.schemas.1527df96_Player.properties.show_progression.description
Indicates whether progression controls should be shown for the Player

# components.schemas.1527df96_Player.properties.suggestions.description
a list media sources to play at the end of current media

# components.schemas.1527df96_Player.properties.show_replay.description
Indicates whether replay controls should be shown for the Player

# components.schemas.1527df96_Player.properties.show_speed.description
Indicates whether speed controls should be shown for the Player

# components.schemas.1527df96_Player.properties.show_viewers.description
Indicates whether viewers count should be shown for the Player

# components.schemas.1527df96_Player.properties.show_viewers_after.description
The time after which viewers count should be shown for the Player

# components.schemas.1527df96_Player.properties.show_viewers_only_after.description
The time only after which viewers count should be shown for the Player

# components.schemas.1527df96_Player.properties.skip_intro_to.description
Number of seconds to reach once the "skip intro" button is pressed, nothing will appear if value is 0

# components.schemas.1527df96_Player.properties.time_before_hide_cb.description
The time before controls should be hidden for the Player

# components.schemas.1527df96_Player.properties.twitter_back_link.description
The back link for Twitter sharing associated with the Player

# components.schemas.1527df96_Player.properties.twitter_related.description
The related Twitter account associated with the Player

# components.schemas.1527df96_Player.properties.twitter_via.description
The Twitter via associated with the Player

# components.schemas.1527df96_Player.properties.logo_image.description
The logo image associated with the Player

# components.schemas.1527df96_Folder.properties.auto_publish.description
Indicates whether media in the Folder is automatically published

# components.schemas.1527df96_Folder.properties.replace_on_upload.description
Indicates whether existing media is replaced upon upload

# components.schemas.1527df96_Folder.properties.auto_generate_subtitle.description
Automatically generates subtitles with AI api for media uploaded in this Folder

# components.schemas.1527df96_Folder.properties.auto_generate_title.description
Automatically generates a title with AI api for media uploaded in this Folder

# components.schemas.1527df96_Folder.properties.auto_generate_description.description
Automatically generates a description with AI api for media uploaded in this Folder

# components.schemas.1527df96_Folder.properties.auto_translate_languages.description
Automatically generate a list of subtitles with AI api in the given language(s) for media uploaded in this Folder

# components.schemas.1527df96_Folder.properties.inherits_media_processing.description
Indicates whether the Folder inherits media processing settings from its parent

# components.schemas.1527df96_Folder.properties.private.description
Indicates if the resource is private or not

# components.schemas.1527df96_Folder.properties.trashed.description
Indicates if the resource is in the trash or not

# components.schemas.1527df96_Folder.properties.suspended_channel.description
Indicates if the Folder is suspended or not

# components.schemas.1527df96_Folder.properties.key_restricted.description
Indicates whether the Folder is restricted with a key

# components.schemas.1527df96_Folder.properties.allowed_countries.items.description
List of allowed countries by country code

# components.schemas.1527df96_Folder.properties.allowed_countries.description
List of allowed countries by country code

# components.schemas.1527df96_Folder.properties.disallowed_countries.items.description
List of disallowed countries by country code

# components.schemas.1527df96_Folder.properties.disallowed_countries.description
List of disallowed countries by country code

# components.schemas.1527df96_Folder.properties.disallowed_domains.items.description
List of disallowed domains for the Folder

# components.schemas.1527df96_Folder.properties.disallowed_domains.description
List of disallowed domains for the Folder

# components.schemas.1527df96_Folder.properties.inherits_restrictions.description
Defines whether or not the resource inherits restrictions settings

# components.schemas.1527df96_Folder.properties.encodings.description
The encodings associated with the Folder

# components.schemas.1527df96_Folder.properties.inherits_encodings.description
Indicates whether the Folder inherits encodings from its parent

# components.schemas.1527df96_Folder.properties.channel_id.description
The identifier of the `channel` resource related to Folder

# components.schemas.1527df96_Folder.properties.player_id.description
The identifier of the `player` resource related to Folder

# components.schemas.1527df96_Folder.properties.auto_validate.description
Indicates whether media uploaded to this folder should be marked as validated automatically

# components.schemas.1527df96_Folder.properties.synchronize_media_encodings.description
Defines whether or not the Folder synchronizes media encodings

# components.schemas.1527df96_Folder.properties.folders_count.description
The number of folders associated with the Folder

# components.schemas.1527df96_Folder.properties.files_count.description
The number of files associated with the Folder

# components.schemas.1527df96_Folder.properties.created_at.description
The date and time when the Folder was created

# components.schemas.1527df96_Folder.properties.updated_at.description
The date and time when the Folder was updated

# components.schemas.1527df96_Folder.properties.discarded_at.description
The date and time when the Folder was discarded

# components.schemas.1527df96_Logo.properties.mode.items.description
The Logo modeoverlay: The logo is added on top of the video by a player configuration embed: The logo is directly encoded in the video

# components.schemas.1527df96_Logo.properties.mode.description
The Logo modeoverlay: The logo is added on top of the video by a player configuration embed: The logo is directly encoded in the video

# components.schemas.1527df96_Logo.properties.position.items.description
The anchor of the Logotop_left: Positioned at the top left corner top_middle: Positioned at the top middle top_right: Positioned at the top right corner center_left: Positioned at the center left center_middle: Positioned at the center middle center_right: Positioned at the center right bottom_left: Positioned at the bottom left corner bottom_middle: Positioned at the bottom middle bottom_right: Positioned at the bottom right corner

# components.schemas.1527df96_Logo.properties.position.description
The anchor of the Logotop_left: Positioned at the top left corner top_middle: Positioned at the top middle top_right: Positioned at the top right corner center_left: Positioned at the center left center_middle: Positioned at the center middle center_right: Positioned at the center right bottom_left: Positioned at the bottom left corner bottom_middle: Positioned at the bottom middle bottom_right: Positioned at the bottom right corner

# components.schemas.1527df96_Logo.properties.created_at.description
The date and time when the Logo was created

# components.schemas.1527df96_Logo.properties.updated_at.description
The date and time when the Logo was updated

# components.schemas.1527df96_Encoding.properties.is_generic.description
Indicates whether the Encoding is shared

# components.schemas.1527df96_Encoding.properties.container.items.description
The Encoding containerflv: Adobe Flash Video container format m4a: MPEG-4 Audio container format mkv: Matroska Multimedia container format mp4: MPEG-4 Multimedia container format webm: WebM Multimedia container format mp3: MPEG-1 or MPEG-2 Audio Layer III audio container copy: Uncompressed, lossless container format aac: Advanced Audio Coding container format

# components.schemas.1527df96_Encoding.properties.container.description
The Encoding containerflv: Adobe Flash Video container format m4a: MPEG-4 Audio container format mkv: Matroska Multimedia container format mp4: MPEG-4 Multimedia container format webm: WebM Multimedia container format mp3: MPEG-1 or MPEG-2 Audio Layer III audio container copy: Uncompressed, lossless container format aac: Advanced Audio Coding container format

# components.schemas.1527df96_Encoding.properties.copy.description
Indicates whether the Encoding is a pure copy

# components.schemas.1527df96_Encoding.properties.video_codec.items.description
The video codech264: Efficient video compression standard hevc: High-efficiency video coding technology theora: Open-source video compression format vp8: Google's video compression standard vp9: High-quality video compression codec copy: Uncompressed, lossless video codec h263: Video compression standard for low bitrates

# components.schemas.1527df96_Encoding.properties.video_codec.description
The video codech264: Efficient video compression standard hevc: High-efficiency video coding technology theora: Open-source video compression format vp8: Google's video compression standard vp9: High-quality video compression codec copy: Uncompressed, lossless video codec h263: Video compression standard for low bitrates

# components.schemas.1527df96_Encoding.properties.video_aspect.items.description
The audio aspectletterbox: Preserves aspect ratio with black bars stretch: Stretches content to fill screen fill: Expands content to fit screen keep_ratio: Maintains original aspect ratio copy: Matches aspect ratio of the source

# components.schemas.1527df96_Encoding.properties.video_aspect.description
The audio aspectletterbox: Preserves aspect ratio with black bars stretch: Stretches content to fill screen fill: Expands content to fit screen keep_ratio: Maintains original aspect ratio copy: Matches aspect ratio of the source

# components.schemas.1527df96_Encoding.properties.video_fps.description
The video frames per second of the Encoding

# components.schemas.1527df96_Encoding.properties.audio_codec.items.description
The audio codecaac: Advanced Audio Coding he_aac: High-Efficiency Advanced Audio Coding flac: Free Lossless Audio Codec mp3: MPEG-1 Audio Layer III vorbis: Open-source audio compression format copy: Uncompressed, lossless audio codec opus: Versatile audio codec

# components.schemas.1527df96_Encoding.properties.audio_codec.description
The audio codecaac: Advanced Audio Coding he_aac: High-Efficiency Advanced Audio Coding flac: Free Lossless Audio Codec mp3: MPEG-1 Audio Layer III vorbis: Open-source audio compression format copy: Uncompressed, lossless audio codec opus: Versatile audio codec

# components.schemas.1527df96_Encoding.properties.audio_channel.items.description
The audio channelmono_1_0: Single-channel audio stereo_2_0: Two-channel audio stereo_2_1: Two-channel audio with subwoofer surround_4_1: Four-channel audio with subwoofer surround_5_1: Six-channel audio (5 speakers + subwoofer)surround_6_1: Seven-channel audio (6 speakers + subwoofer)surround_7_1: Eight-channel audio (7 speakers + subwoofer)

# components.schemas.1527df96_Encoding.properties.audio_channel.description
The audio channelmono_1_0: Single-channel audio stereo_2_0: Two-channel audio stereo_2_1: Two-channel audio with subwoofer surround_4_1: Four-channel audio with subwoofer surround_5_1: Six-channel audio (5 speakers + subwoofer)surround_6_1: Seven-channel audio (6 speakers + subwoofer)surround_7_1: Eight-channel audio (7 speakers + subwoofer)

# components.schemas.1527df96_Encoding.properties.created_at.description
The date and time when the Encoding was created

# components.schemas.1527df96_Encoding.properties.updated_at.description
The date and time when the Encoding was updated

# components.schemas.1527df96_Stream.properties.audio_sampling.description
The audio sampling rate of the Stream stream

# components.schemas.1527df96_FolderExcerpt.properties.id.description
The unique identifier of the Folder Excerpt

# components.schemas.1527df96_FolderExcerpt.properties.channel_id.description
The identifier of the `channel` resource related to Folder Excerpt

# components.schemas.1527df96_FolderExcerpt.properties.auto_validate.description
Indicates whether media uploaded to this folder should be marked as validated automatically

# components.schemas.1527df96_FolderExcerpt.properties.auto_publish.description
Indicates whether media in the Folder Excerpt is automatically published

# components.schemas.1527df96_FolderExcerpt.properties.replace_on_upload.description
Indicates whether existing media is replaced upon upload

# components.schemas.1527df96_FolderExcerpt.properties.synchronize_media_encodings.description
Defines whether or not the Folder Excerpt synchronizes media encodings

# components.schemas.1527df96_FolderExcerpt.properties.created_at.description
The date and time when the Folder Excerpt was created

# components.schemas.1527df96_FolderExcerpt.properties.updated_at.description
The date and time when the Folder Excerpt was updated

# components.schemas.1527df96_FolderExcerpt.properties.discarded_at.description
The date and time when the Folder Excerpt was discarded

# components.schemas.1527df96_Advertisement.properties.id.description
The unique identifier of the Advertisement

# components.schemas.1527df96_Advertisement.properties.category.items.description
The category of Advertisementvast: The advertisement is from a vast video: The advertisement is from a video none: There is no advertisement

# components.schemas.1527df96_Advertisement.properties.category.description
The category of Advertisementvast: The advertisement is from a vast video: The advertisement is from a video none: There is no advertisement

# components.schemas.1527df96_Advertisement.properties.type.items.description
The type of Advertisementpre_roll: Advertisement displayed before the main content mid_roll: Advertisement displayed during the main content pst_roll: Advertisement displayed after the main content

# components.schemas.1527df96_Advertisement.properties.type.description
The type of Advertisementpre_roll: Advertisement displayed before the main content mid_roll: Advertisement displayed during the main content pst_roll: Advertisement displayed after the main content

# components.schemas.1527df96_Advertisement.properties.offset.description
The offset after which the Advertisement gets loaded

# components.schemas.1527df96_Advertisement.properties.skip_after.description
The time in seconds after which the Advertisement can be skipped

# components.schemas.1527df96_Advertisement.properties.created_at.description
The date and time when the Advertisement was created

# components.schemas.1527df96_Advertisement.properties.updated_at.description
The date and time when the Advertisement was updated

# components.schemas.1527df96_Subtitle.properties.default.description
Indicates whether the Subtitle is set as default

# components.schemas.1527df96_Playlist.properties.type.description
Playlist typestatic: Allows only media to be added to the playlist dynamic: Add a folder to the playlist: all subsequent media added/removed will be synced to the playlist

# components.schemas.1527df96_Playlist.properties.mode.description
Playlist mode (changes progressbar behaviour)merge: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media split: Each media will be played individually: the progress-bar will be independent for each media live: The playlist will act as a live streaming: no scrubbing will be allowed

# components.schemas.1527df96_Playlist.properties.sort.description
Playlist order criterionauto: Sorted automatically created_asc: By creation date in ascending order created_desc: By creation date in descending order name_asc: By name in ascending order name_desc: By name in descending order duration_asc: By duration in ascending order duration_desc: By duration in descending order views_asc: By views in ascending order views_desc: By views in descending order random: Randomly sorted manual: Manually sorted

# components.schemas.1527df96_Playlist.properties.auto_add_media_by_name.description
When a new media with name containing one of the configured values is uploaded, automatically add it to the playlist

# components.schemas.1527df96_Playlist.properties.auto_add_media_by_description.description
When a new media with description containing one of the configured values is uploaded, automatically add it to the playlist

# components.schemas.1527df96_Playlist.properties.nav_position.description
Playlist nav positionabove: Controls are placed above the playlist below: Controls are placed below the playlist

# components.schemas.1527df96_Playlist.properties.chapter_style.description
Playlist chapter styledark: Darker colors light: Lighter colors

# components.schemas.1527df96_Playlist.properties.show_controls.description
Indicates whether controls should be shown for the Playlist

# components.schemas.1527df96_Media.properties.source.description
The media playback link.
May return 403 error if protected.

# components.schemas.1527df96_Media.properties.suggestions.description
a list media sources to play at the end of current media

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.id.description
The unique identifier of the Media Stream Single Bitrate

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.video_bitrate.description
The video bitrate of the Media Stream Single Bitrate stream

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.video_width.description
The video width of the Media Stream Single Bitrate stream

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.video_height.description
The video height of the Media Stream Single Bitrate stream

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.audio_bitrate.description
The audio bitrate of the Media Stream Single Bitrate stream

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.audio_sampling.description
The audio sampling rate of the Media Stream Single Bitrate stream

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.container.items.description
The Media Stream Single Bitrate containerflv: Adobe Flash Video container format m4a: MPEG-4 Audio container format mkv: Matroska Multimedia container format mp4: MPEG-4 Multimedia container format webm: WebM Multimedia container format mp3: MPEG-1 or MPEG-2 Audio Layer III audio container copy: Uncompressed, lossless container format aac: Advanced Audio Coding container format

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.container.description
The Media Stream Single Bitrate containerflv: Adobe Flash Video container format m4a: MPEG-4 Audio container format mkv: Matroska Multimedia container format mp4: MPEG-4 Multimedia container format webm: WebM Multimedia container format mp3: MPEG-1 or MPEG-2 Audio Layer III audio container copy: Uncompressed, lossless container format aac: Advanced Audio Coding container format

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.name.description
The name of the Media Stream Single Bitrate

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.source.description
The source of the Media Stream Single Bitrate

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.size.description
The size of the Media Stream Single Bitrate

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.copy.description
Indicates whether the Media Stream Single Bitrate is a pure copy

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.video_codec.items.description
The video codech264: Efficient video compression standard hevc: High-efficiency video coding technology theora: Open-source video compression format vp8: Google's video compression standard vp9: High-quality video compression codec copy: Uncompressed, lossless video codec h263: Video compression standard for low bitrates

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.video_codec.description
The video codech264: Efficient video compression standard hevc: High-efficiency video coding technology theora: Open-source video compression format vp8: Google's video compression standard vp9: High-quality video compression codec copy: Uncompressed, lossless video codec h263: Video compression standard for low bitrates

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.video_aspect.items.description
The audio aspectletterbox: Preserves aspect ratio with black bars stretch: Stretches content to fill screen fill: Expands content to fit screen keep_ratio: Maintains original aspect ratio copy: Matches aspect ratio of the source

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.video_aspect.description
The audio aspectletterbox: Preserves aspect ratio with black bars stretch: Stretches content to fill screen fill: Expands content to fit screen keep_ratio: Maintains original aspect ratio copy: Matches aspect ratio of the source

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.video_fps.description
The video frames per second of the Media Stream Single Bitrate

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.audio_codec.items.description
The audio codecaac: Advanced Audio Coding he_aac: High-Efficiency Advanced Audio Coding flac: Free Lossless Audio Codec mp3: MPEG-1 Audio Layer III vorbis: Open-source audio compression format copy: Uncompressed, lossless audio codec opus: Versatile audio codec

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.audio_codec.description
The audio codecaac: Advanced Audio Coding he_aac: High-Efficiency Advanced Audio Coding flac: Free Lossless Audio Codec mp3: MPEG-1 Audio Layer III vorbis: Open-source audio compression format copy: Uncompressed, lossless audio codec opus: Versatile audio codec

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.audio_channel.items.description
The audio channelmono_1_0: Single-channel audio stereo_2_0: Two-channel audio stereo_2_1: Two-channel audio with subwoofer surround_4_1: Four-channel audio with subwoofer surround_5_1: Six-channel audio (5 speakers + subwoofer)surround_6_1: Seven-channel audio (6 speakers + subwoofer)surround_7_1: Eight-channel audio (7 speakers + subwoofer)

# components.schemas.1527df96_MediaStreamSingleBitrate.properties.audio_channel.description
The audio channelmono_1_0: Single-channel audio stereo_2_0: Two-channel audio stereo_2_1: Two-channel audio with subwoofer surround_4_1: Four-channel audio with subwoofer surround_5_1: Six-channel audio (5 speakers + subwoofer)surround_6_1: Seven-channel audio (6 speakers + subwoofer)surround_7_1: Eight-channel audio (7 speakers + subwoofer)

# components.schemas.1527df96_MediaAdaptativeStream.properties.strategy.description
The Media Adaptative Stream playback strategy

# components.schemas.1527df96_MediaAdaptativeStream.properties.description.description
The description of the Media Adaptative Stream

# components.schemas.1527df96_MediaAdaptativeStream.properties.description.example
Wow, such a nice Media Adaptative Stream !

# components.schemas.1527df96_MediaAdaptativeStream.properties.source.description
The source of the Media Adaptative Stream

# components.schemas.1527df96_MediaAdaptativeStream.properties.streams.description
The streams associated with Media Adaptative Stream

# components.schemas.1527df96_MediaSourceStream.properties.video_bitrate.description
The video bitrate of the Media Source Stream stream

# components.schemas.1527df96_MediaSourceStream.properties.video_width.description
The video width of the Media Source Stream stream

# components.schemas.1527df96_MediaSourceStream.properties.video_height.description
The video height of the Media Source Stream stream

# components.schemas.1527df96_MediaSourceStream.properties.audio_bitrate.description
The audio bitrate of the Media Source Stream stream

# components.schemas.1527df96_MediaSourceStream.properties.audio_sampling.description
The audio sampling rate of the Media Source Stream stream

# components.schemas.1527df96_Mixtape.properties.media_count.description
The total count of media associated with the Mixtape

# components.schemas.1527df96_Mixtape.properties.valid_until.description
The date and time until which the Mixtape is valid

# components.schemas.1527df96_Mixtape.properties.created_at.description
The date and time when the Mixtape was created

# components.schemas.1527df96_Chapter.properties.published.description
Indicates whether the Chapter is publicly accessible

# components.schemas.1527df96_Chapter.properties.created_at.description
The date and time when the Chapter was created

# components.schemas.1527df96_Chapter.properties.updated_at.description
The date and time when the Chapter was updated

# components.schemas.1527df96_EncodingConstraints.properties.video_aspects.items.description
Available video aspect ratios for encoding

# components.schemas.1527df96_EncodingConstraints.properties.video_aspects.description
Available video aspect ratios for encoding

# components.schemas.1527df96_VideoEncodingCodec.properties.value.description
The value associated with the Video Encoding Codec

# components.schemas.1527df96_VideoEncodingCodec.properties.description.description
The description of the Video Encoding Codec

# components.schemas.1527df96_VideoEncodingCodec.properties.supported_by_player.description
Indicates whether the Video Encoding Codec is supported by the player

# components.schemas.1527df96_VideoEncodingCodec.properties.bitrate_min.description
The minimum bitrate supported by the Video Encoding Codec

# components.schemas.1527df96_VideoEncodingCodec.properties.bitrate_max.description
The maximum bitrate supported by the Video Encoding Codec

# components.schemas.1527df96_VideoEncodingCodec.properties.fps_min.description
The minimum frames per second (FPS) supported by the Video Encoding Codec

# components.schemas.1527df96_VideoEncodingCodec.properties.fps_max.description
The maximum frames per second (FPS) supported by the Video Encoding Codec

# components.schemas.1527df96_AudioEncodingCodec.properties.value.description
The value associated with the Audio Encoding Codec

# components.schemas.1527df96_AudioEncodingCodec.properties.supported_by_player.description
Indicates whether the Audio Encoding Codec is supported by the player

# components.schemas.1527df96_AudioEncodingCodec.properties.bitrate_min.description
The minimum bitrate supported by the Audio Encoding Codec

# components.schemas.1527df96_AudioEncodingCodec.properties.bitrate_max.description
The maximum bitrate supported by the Audio Encoding Codec

# components.schemas.1527df96_AudioEncodingCodec.properties.samplings.items.description
The samplings supported by the Audio Encoding Codec

# components.schemas.1527df96_AudioEncodingCodec.properties.samplings.description
The samplings supported by the Audio Encoding Codec

# components.schemas.1527df96_EncodingContainer.properties.value.description
The value associated with the Encoding Container

# components.schemas.1527df96_Channelencodingprofiles.properties.play.description
Encodings included in the profile dedicated to playback, advised by infomaniak

# components.schemas.1527df96_Channelencodingprofiles.properties.stor.description
Encodings included in the low resources encoding for storage

# components.schemas.1527df96_MediaExcerpt.properties.id.description
The unique identifier of the Media Excerpt

# components.schemas.1527df96_MediaExcerpt.properties.validated.description
Indicates whether the Media Excerpt is validated

# components.schemas.1527df96_MediaExcerpt.properties.published.description
Indicates whether the Media Excerpt is publicly accessible

# components.schemas.1527df96_MediaExcerpt.properties.types.items.description
Media Excerpt video streamsaudio: Media has an audio stream video: Media has a video stream

# components.schemas.1527df96_MediaExcerpt.properties.types.description
Media Excerpt video streamsaudio: Media has an audio stream video: Media has a video stream

# components.schemas.1527df96_MediaExcerpt.properties.state.items.description
Contains information about Media Excerpt encoding status and availability.idle: Media has nothing going on deleted: Media is deleted transferring: Media upload is in progress: transferring from the remote source initializing: Media is initializing: bootstrapping and doing pre-flight checks await_encoding: No encodings are available for the current media encoding: Media has at least one encoding in progress available: Media can be displayed on a video player ready: Media is ready: all encodings & thumbnails have been processed e_transient: Media is experiencing a transient error e_fatal: Something is gone wrong

# components.schemas.1527df96_MediaExcerpt.properties.state.description
Contains information about Media Excerpt encoding status and availability.idle: Media has nothing going on deleted: Media is deleted transferring: Media upload is in progress: transferring from the remote source initializing: Media is initializing: bootstrapping and doing pre-flight checks await_encoding: No encodings are available for the current media encoding: Media has at least one encoding in progress available: Media can be displayed on a video player ready: Media is ready: all encodings & thumbnails have been processed e_transient: Media is experiencing a transient error e_fatal: Something is gone wrong

# components.schemas.1527df96_MediaExcerpt.properties.collected_at.description
The date and time when the Media Excerpt was gathered by the VOD

# components.schemas.1527df96_MediaExcerpt.properties.created_at.description
The date and time when the Media Excerpt was created

# components.schemas.1527df96_MediaExcerpt.properties.updated_at.description
The date and time when the Media Excerpt was updated

# components.schemas.1527df96_MediaExcerpt.properties.discarded_at.description
The date and time when the Media Excerpt was discarded

# components.schemas.1527df96_Mediastatus.properties.pending.description
Number of pending media for the current channel for the requested period

# components.schemas.1527df96_Mediastatus.properties.progressing.description
Number of progressing media for the current channel for the requested period

# components.schemas.1527df96_Mediastatus.properties.failed.description
Number of failed media for the current channel for the requested period

# components.schemas.1527df96_Mediastatus.properties.done.description
Number of done media for the current channel for the requested period

# components.schemas.1527df96_Mediaactivity.properties.id.description
The unique identifier of the Media activity

# components.schemas.1527df96_Mediaactivity.properties.streams.items.description
list of media streamsaudio: Media has an audio stream video: Media has a video stream

# components.schemas.1527df96_Mediaactivity.properties.streams.description
list of media streamsaudio: Media has an audio stream video: Media has a video stream

# components.schemas.1527df96_Mediaactivity.properties.state.description
activity statusnew: The activity is newly created acknowledged: User acknowledged message fixed: The error activity has been fixed ignored: Ignored activity

# components.schemas.1527df96_Mediaactivity.properties.channel_id.description
The identifier of the `channel` resource related to Media activity

# components.schemas.1527df96_Mediaactivity.properties.cause.description
The event name triggering the Media activity

# components.schemas.1527df96_Mediaactivity.properties.error.description
In case the Media activity is an error, the underlying message

# components.schemas.1527df96_Mediaactivity.properties.created_at.description
The date and time when the Media activity was created

# components.schemas.1527df96_Thumbnail.properties.type.items.description
Thumbnail typeimage: Main image of the media, used as preload image in the video player audio_preview: Waveform image audio_waveform: Waveform binary data audio_sample: Audio file containing an excerpt of the media (audio only)video_preview: 10x10 spritemap of the media video_sample: `1xN` low res spritemap of the media containing an image per second thumbstrip: 10x300 medium res spritemap of the media containing an image per second scenes: 10x300 medium res spritemap of the media containing an image for each scene change poster: High res thumbnail image, may be used for user integration

# components.schemas.1527df96_Thumbnail.properties.type.description
Thumbnail typeimage: Main image of the media, used as preload image in the video player audio_preview: Waveform image audio_waveform: Waveform binary data audio_sample: Audio file containing an excerpt of the media (audio only)video_preview: 10x10 spritemap of the media video_sample: `1xN` low res spritemap of the media containing an image per second thumbstrip: 10x300 medium res spritemap of the media containing an image per second scenes: 10x300 medium res spritemap of the media containing an image for each scene change poster: High res thumbnail image, may be used for user integration

# components.schemas.1527df96_Thumbnail.properties.on_filesystem.description
Indicates whether the Thumbnail is stored on the filesystem

# components.schemas.1527df96_Thumbnail.properties.created_at.description
The date and time when the Thumbnail was created

# components.schemas.1527df96_Thumbnail.properties.updated_at.description
The date and time when the Thumbnail was updated

# components.schemas.1527df96_Share.properties.manifest_url.description
The JSON manifest rendering URL of Share

# components.schemas.1527df96_Share.properties.embed_url.description
The URL of Share to be used for iframes integration

# components.schemas.1527df96_Share.properties.share_url.description
The URL of Share used for public sharing

# components.schemas.1527df96_Share.properties.channel_id.description
The identifier of the `channel` resource related to Share

# components.schemas.1527df96_Share.properties.valid_until.description
The date and time until which the Share is valid

# components.schemas.1527df96_Share.properties.created_at.description
The date and time when the Share was created

# components.schemas.1527df96_Share.properties.updated_at.description
The date and time when the Share was updated

# components.schemas.1527df96_Playlistsettings.properties.mode.items.description
Playlist settings mode (changes progressbar behaviour)merge: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media split: Each media will be played individually: the progress-bar will be independent for each media live: The playlist will act as a live streaming: no scrubbing will be allowed

# components.schemas.1527df96_Playlistsettings.properties.mode.description
Playlist settings mode (changes progressbar behaviour)merge: The playlist playback will be uninterrupted: the media duration will be the sum of all playlist media split: Each media will be played individually: the progress-bar will be independent for each media live: The playlist will act as a live streaming: no scrubbing will be allowed

# components.schemas.1527df96_Playlistsettings.properties.show_media_thumbnail.description
Indicates whether media thumbnail should be shown for the Playlist settings

# components.schemas.1527df96_Playlistsettings.properties.show_media_info.description
Indicates whether media information should be shown for the Playlist settings

# components.schemas.1527df96_Playlistsettings.properties.nav_position.items.description
Playlist settings nav positionabove: Controls are placed above the playlist below: Controls are placed below the playlist

# components.schemas.1527df96_Playlistsettings.properties.nav_position.description
Playlist settings nav positionabove: Controls are placed above the playlist below: Controls are placed below the playlist

# components.schemas.1527df96_Playlistsettings.properties.chapter_style.items.description
Playlist settings chapter styledark: Darker colors light: Lighter colors

# components.schemas.1527df96_Playlistsettings.properties.chapter_style.description
Playlist settings chapter styledark: Darker colors light: Lighter colors

# components.schemas.1527df96_Playersettings.properties.auto_start.description
Indicates whether media should start automatically for the Player settings

# components.schemas.1527df96_Playersettings.properties.show_loop.description
Indicates whether loop controls should be shown for the Player settings

# components.schemas.1527df96_Playersettings.properties.force_media_ratio.description
Indicates whether media ratio is enforced for the Player settings

# components.schemas.1527df96_Playersettings.properties.show_progression.description
Indicates whether progression controls should be shown for the Player settings

# components.schemas.1527df96_Stream_9339d051.properties.container.items.description
The Stream containerflv: Adobe Flash Video container format m4a: MPEG-4 Audio container format mkv: Matroska Multimedia container format mp4: MPEG-4 Multimedia container format webm: WebM Multimedia container format mp3: MPEG-1 or MPEG-2 Audio Layer III audio container copy: Uncompressed, lossless container format aac: Advanced Audio Coding container format

# components.schemas.1527df96_Stream_9339d051.properties.container.description
The Stream containerflv: Adobe Flash Video container format m4a: MPEG-4 Audio container format mkv: Matroska Multimedia container format mp4: MPEG-4 Multimedia container format webm: WebM Multimedia container format mp3: MPEG-1 or MPEG-2 Audio Layer III audio container copy: Uncompressed, lossless container format aac: Advanced Audio Coding container format

# components.schemas.1527df96_Stream_9339d051.properties.copy.description
Indicates whether the Stream is a pure copy

# components.schemas.1527df96_Stream_9339d051.properties.video_codec.items.description
The video codech264: Efficient video compression standard hevc: High-efficiency video coding technology theora: Open-source video compression format vp8: Google's video compression standard vp9: High-quality video compression codec copy: Uncompressed, lossless video codec h263: Video compression standard for low bitrates

# components.schemas.1527df96_Stream_9339d051.properties.video_codec.description
The video codech264: Efficient video compression standard hevc: High-efficiency video coding technology theora: Open-source video compression format vp8: Google's video compression standard vp9: High-quality video compression codec copy: Uncompressed, lossless video codec h263: Video compression standard for low bitrates

# components.schemas.1527df96_Stream_9339d051.properties.video_aspect.items.description
The audio aspectletterbox: Preserves aspect ratio with black bars stretch: Stretches content to fill screen fill: Expands content to fit screen keep_ratio: Maintains original aspect ratio copy: Matches aspect ratio of the source

# components.schemas.1527df96_Stream_9339d051.properties.video_aspect.description
The audio aspectletterbox: Preserves aspect ratio with black bars stretch: Stretches content to fill screen fill: Expands content to fit screen keep_ratio: Maintains original aspect ratio copy: Matches aspect ratio of the source

# components.schemas.1527df96_Stream_9339d051.properties.video_fps.description
The video frames per second of the Stream

# components.schemas.1527df96_Stream_9339d051.properties.audio_codec.items.description
The audio codecaac: Advanced Audio Coding he_aac: High-Efficiency Advanced Audio Coding flac: Free Lossless Audio Codec mp3: MPEG-1 Audio Layer III vorbis: Open-source audio compression format copy: Uncompressed, lossless audio codec opus: Versatile audio codec

# components.schemas.1527df96_Stream_9339d051.properties.audio_codec.description
The audio codecaac: Advanced Audio Coding he_aac: High-Efficiency Advanced Audio Coding flac: Free Lossless Audio Codec mp3: MPEG-1 Audio Layer III vorbis: Open-source audio compression format copy: Uncompressed, lossless audio codec opus: Versatile audio codec

# components.schemas.1527df96_Stream_9339d051.properties.audio_channel.items.description
The audio channelmono_1_0: Single-channel audio stereo_2_0: Two-channel audio stereo_2_1: Two-channel audio with subwoofer surround_4_1: Four-channel audio with subwoofer surround_5_1: Six-channel audio (5 speakers + subwoofer)surround_6_1: Seven-channel audio (6 speakers + subwoofer)surround_7_1: Eight-channel audio (7 speakers + subwoofer)

# components.schemas.1527df96_Stream_9339d051.properties.audio_channel.description
The audio channelmono_1_0: Single-channel audio stereo_2_0: Two-channel audio stereo_2_1: Two-channel audio with subwoofer surround_4_1: Four-channel audio with subwoofer surround_5_1: Six-channel audio (5 speakers + subwoofer)surround_6_1: Seven-channel audio (6 speakers + subwoofer)surround_7_1: Eight-channel audio (7 speakers + subwoofer)

# components.schemas.1527df96_Stream_9339d051.properties.created_at.description
The date and time when the Stream was created

# components.schemas.1527df96_Stream_9339d051.properties.updated_at.description
The date and time when the Stream was updated

# components.schemas.1527df96_Stream_3370c276.properties.audio_sampling.description
The audio sampling rate of the Stream stream

# components.schemas.1527df96_MediaWithLabels.properties.media_id.description
The identifier of the `media` resource related to Media With Labels

# components.schemas.1527df96_Mediaitem.properties.unique_viewers.description
The number of unique viewers (unique IP addresses)

# components.schemas.1527df96_Averageviewtimesummary.properties.unique_viewers.description
The number of unique viewers (unique IP addresses)

# components.schemas.1527df96_Histogramwrapper.properties.histogram.description
The values of the histogram grouped by time buckets

# components.schemas.1527df96_Histogramwrapper.properties.encodings_map.description
List of encodings with their IDs and display names

# components.schemas.1527df96_Viewerswithencodingshistogrambucket.properties.key.description
the epoch time of the Viewers with encodings histogram bucket

# components.schemas.1527df96_Viewerswithencodingshistogrambucket.properties.unique_viewers.description
The number of unique viewers (unique IP addresses)

# components.schemas.1527df96_Viewerswithencodingshistogrambucket.properties.encodings.description
The encodings associated with the Viewers with encodings histogram bucket

# components.schemas.1527df96_Encodingbucket.properties.unique_viewers.description
The number of unique viewers (unique IP addresses)

# components.schemas.1527df96_Lookupitem.properties.id.description
The unique identifier of the Lookup item

# components.schemas.1527df96_Viewersbucket.properties.unique_viewers.description
The number of unique viewers (unique IP addresses)

# components.schemas.1527df96_Countryshareitem.properties.country_code.description
The country code of the Country share item

# components.schemas.1527df96_Countryshareitem.properties.share.description
Share of the total value represented by this {Country share item}, expressed as a percentage (0–100).

# components.schemas.1527df96_Encodingitem.properties.id.description
The unique identifier of the Encoding item

# components.schemas.1527df96_Ranksummary.properties.total_media.description
The total number of media in the channel

# components.schemas.1527df96_ShareAndMedia.properties.comment.description
The comment associated with the ShareAndMedia

# components.schemas.1527df96_ShareAndMedia.properties.valid_until.description
The date and time until which the ShareAndMedia is valid

# components.schemas.1527df96_Ad.properties.type.items.description
The type of Adpre_roll: Advertisement displayed before the main content mid_roll: Advertisement displayed during the main content pst_roll: Advertisement displayed after the main content

# components.schemas.1527df96_Ad.properties.type.description
The type of Adpre_roll: Advertisement displayed before the main content mid_roll: Advertisement displayed during the main content pst_roll: Advertisement displayed after the main content

# components.schemas.1527df96_Ad.properties.offset.description
The offset after which the Ad gets loaded

# components.schemas.1527df96_Ad.properties.skip_after.description
The time in seconds after which the Ad can be skipped

# components.schemas.1527df96_Product_5eb4fc6f.properties.account_id.description
The identifier of the `account` resource related to Product

# components.schemas.1527df96_Product_5eb4fc6f.properties.service_id.description
The identifier of the `service` resource related to Product

# components.schemas.1527df96_Product_5eb4fc6f.properties.created_at.description
The date and time when the Product was created

# components.schemas.1527df96_Product_5eb4fc6f.properties.expired_at.description
The date and time when the Product was expired

# components.schemas.1527df96_Product_5eb4fc6f.properties.deleted_at.description
The date and time when the Product was deleted

# components.schemas.1527df96_Product_5eb4fc6f.properties.has_maintenance.description
Does the resource Product have a maintenance mode enabled

# components.schemas.1527df96_Product_5eb4fc6f.properties.has_operation_in_progress.description
Does the resource Product have an operation in progress

# components.schemas.1527df96_Product_5eb4fc6f.properties.unique_id.description
The identifier of the `unique` resource related to Product

# components.schemas.1527df96_Product_5eb4fc6f.properties.bill_reference.description
The reference number associated with the invoice

# components.schemas.1527df96_Product_5eb4fc6f.properties.is_zero_price.description
Does the resource Product have a zero price status

# components.schemas.1527df96_Product_5eb4fc6f.properties.is_trial.description
Does the resource Product have a trial status

# components.schemas.1527df96_Product_5eb4fc6f.properties.parent_id.description
The identifier of the `parent` resource related to Product

# components.schemas.1527df96_Product_5eb4fc6f.properties.parent_service_id.description
The ID of the parent service for the Product

# components.schemas.1527df96_Product_5eb4fc6f.properties.parent_service_name.description
The name of the parent service for the Product

# components.schemas.1527df96_Product_5eb4fc6f.properties.fqdn.description
Fully qualified domain name of the Product

# components.schemas.ErrorResponse.title
Generic error response schema to be reused

# components.schemas.8b850b75_PrivateLink.properties.total_downloads.description
the number of files downloaded via this link

# components.schemas.8b850b75_PrivateTransfer.properties.sender_email.description
the email of the sender if he has no account

# components.schemas.8b850b75_PrivateTransfer.properties.sender_id.description
the user identifier if he has an account

# components.schemas.8b850b75_Features.properties.no-ads.description
Whether the no-ads feature flag is active

# components.schemas.8b850b75_Features.properties.display-history.description
Whether the display-history feature flag is active

# components.schemas.8b850b75_Features.properties.theme.description
Whether the theme feature flag is active

# components.schemas.8b850b75_Features.properties.extension-reminder.description
Whether the extension-reminder feature flag is active

# components.schemas.8b850b75_About.properties.description.example
We provide secure file sharing services.

# components.schemas.8b850b75_About.properties.social_networks.description
Social networks linked to this about section

# components.schemas.8b850b75_SocialNetwork.properties.platform.description
Social platform (facebook, x, linkedin, etc.)

# components.schemas.8b850b75_VisualIdentity.properties.logo_source.description
Logo source (none, account, account_app, asset)

# components.schemas.8b850b75_Account.properties.type.description
Whether the account is ksuite or my_ksuite

# components.schemas.8b850b75_Limits.properties.transfer_total_size.description
Maximum total size of a transfer in bytes

# components.schemas.78d6c681_Domain.properties.id.description
Unique identifier of the resource `Domain`

# components.schemas.78d6c681_Provider.properties.id.description
Unique identifier of the resource `Provider`

# components.schemas.78d6c681_Account.properties.id.description
Unique identifier of the resource `Account`

# components.schemas.78d6c681_Campaign.properties.id.description
Unique identifier of the resource `Campaign`

# components.schemas.78d6c681_Subscriber.properties.id.description
Unique identifier of the resource `Subscriber`

# components.schemas.78d6c681_Group.properties.id.description
Unique identifier of the resource `Group`

# components.schemas.78d6c681_Group.properties.domain.description
Unique identifier of the `Domain` to request

# components.schemas.78d6c681_Source.properties.id.description
Unique identifier of the resource `Source`

# components.schemas.78d6c681_Field.properties.id.description
Unique identifier of the resource `Field`

# components.schemas.78d6c681_Credit.properties.id.description
Unique identifier of the resource `Credit`

# components.schemas.78d6c681_Segment.properties.id.description
Unique identifier of the resource `Segment`

# components.schemas.78d6c681_Template.properties.id.description
Unique identifier of the resource `Template`

# components.schemas.78d6c681_Webform.properties.id.description
Unique identifier of the resource `Webform`

# components.schemas.a57c9d69_Channel.properties.id.description
Unique identifier of the resource `Channel`

# components.schemas.a57c9d69_Channel.properties.unique_id.description
Unique identifier of the resource `Channel`

# components.schemas.a57c9d69_Channel.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Channel`

# components.schemas.a57c9d69_Channel.properties.service_id.description
Unique identifier of the `service` that is related to the resource `Channel`

# components.schemas.a57c9d69_stream.properties.stream_id.description
Unique identifier of the `stream` that is related to the resource `stream`

# components.schemas.a57c9d69_stream.properties.transcoding_option_id.description
Unique identifier of the `Option transcoding` that is related to the resource `stream`

# components.schemas.a57c9d69_stream.properties.restrictions_id.description
Unique identifier of the `restriction` that is related to the resource `stream`

# components.schemas.a57c9d69_stream.properties.recording_config_id.description
Unique identifier of the `recording config` that is related to the resource `stream`

# components.schemas.a57c9d69_ViewersRestrictions.properties.restrictions_id.description
Unique identifier of the `restriction` that is related to the resource `ViewersRestrictions`

# components.schemas.a57c9d69_Player.properties.player_id.description
Unique identifier of the `player` that is related to the resource `Player`

# components.schemas.a57c9d69_Player.properties.name.description
Name of the ressource `Player` visible by final customer

# components.schemas.a57c9d69_Player.properties.buffer.description
Buffer memory enables the reduction of video interruptions if yours viewers connections become unstable by preloading

# components.schemas.a57c9d69_Player.properties.auto_start.description
Start the video automatically (does not function on Android and iOS)

# components.schemas.a57c9d69_Player.properties.is360.description
This option is required to display your 360 video streaming

# components.schemas.a57c9d69_Player.properties.auto_hide_controls.description
Hide the playback bar after a few seconds

# components.schemas.a57c9d69_Player.properties.show_viewers_after.description
Display from the following number after {number} viewers

# components.schemas.a57c9d69_Player.properties.width.description
The width used for render the `Player` (px)

# components.schemas.a57c9d69_Player.properties.height.description
The height used for render the `Player` (px)

# components.schemas.a57c9d69_Player.properties.control_color.description
The background color used in the `Player`

# components.schemas.a57c9d69_Player.properties.control_active_color.description
The secondary color color used in the `Player`

# components.schemas.a57c9d69_Player.properties.use_preload_img.description
This image is displayed before the video is played.

# components.schemas.a57c9d69_Player.properties.interrupt_img.description
This image is displayed if the viewer is not authorised to view the broadcast (IP, domain, unique hash code, etc.)

# components.schemas.a57c9d69_Player.properties.use_restrict_img.description
This image is displayed if the viewer is located in an unauthorised geographic

# components.schemas.a57c9d69_Player.properties.restrict_img.description
This image is displayed if the viewer is not authorised to view the broadcast (IP, domain, unique hash code, etc.)

# components.schemas.a57c9d69_Player.properties.countdown_txt.description
Description of the countdown of the `Player` visible by final customer

# components.schemas.a57c9d69_Player.properties.enable_embed_code.description
Authorise other users to intergrate your live event on their sites

# components.schemas.a57c9d69_Player.properties.facebook_back_link.description
The Twitter backlink used to facebook embed

# components.schemas.a57c9d69_Player.properties.twitter_back_link.description
The Twitter backlink used to twitter embed

# components.schemas.a57c9d69_Player.properties.twitter_related.description
The Twitter hashtag used to Twitter embed

# components.schemas.a57c9d69_Player.properties.chromecast.description
you need to use a player that supports https in order for chromecast to work correctly

# components.schemas.a57c9d69_Player.properties.interrupted.description
There is an event currently interrupting the live;

# components.schemas.a57c9d69_Player.properties.integrations.description
List all the raw integrations supported for the given channel.

# components.schemas.a57c9d69_Integrationsressource.properties.stream_id.description
Unique identifier of the `stream` that is related to the resource `Integrations ressource`

# components.schemas.a57c9d69_RepeatablePlannedEvent.properties.stream_id.description
Unique identifier of the `stream` that is related to the resource `RepeatablePlannedEvent`

# components.schemas.a57c9d69_RepeatablePlannedEvent.properties.storage_machine_id.description
Unique identifier of the `channel` that is related to the resource `RepeatablePlannedEvent`

# components.schemas.a57c9d69_RepeatablePlannedEvent.properties.name.description
Name of the resource `RepeatablePlannedEvent`

# components.schemas.a57c9d69_RepeatablePlannedEvent.properties.type.description
only=>Change only this event, all=>Change all event, from=>Change this event and recurrences

# components.schemas.a57c9d69_RecordingConfig.properties.recording_config_id.description
Unique identifier of the `recording config` that is related to the resource `RecordingConfig`

# components.schemas.a57c9d69_Record.properties.stream_id.description
Unique identifier of the `stream` that is related to the resource `Record`

# components.schemas.a57c9d69_StorageMachine.properties.storage_machine_id.description
Unique identifier of the `channel` that is related to the resource `StorageMachine`

# components.schemas.a57c9d69_StorageMachine.properties.vod_id.description
Unique identifier of the `vodProduct` that is related to the resource `StorageMachine`

# components.schemas.a57c9d69_StorageMachine.properties.recording_config_id.description
Unique identifier of the `recording config` that is related to the resource `StorageMachine`

# components.schemas.a57c9d69_StorageMachine.properties.deleted_at.description
Timestamp `StorageMachine` has been deleted

# components.schemas.a57c9d69_TimeshiftConfig.properties.record_window_duration.description
Define how far your viewers can go back (max.: 240 minutes)

# components.schemas.a57c9d69_SimulcastConfig.properties.stream_id.description
Unique identifier of the `stream` that is related to the resource `SimulcastConfig`

# components.schemas.a57c9d69_SimulcastConfig.properties.deleted_at.description
Timestamp `SimulcastConfig` has been deleted

# components.schemas.a57c9d69_PackOrder.properties.allowed_excess.description
Define a limit before the interruption of live events in case of overrun

# components.schemas.a57c9d69_PackOrder.properties.internal_name.description
Define a internal name for a package order

# components.schemas.a57c9d69_PackOrder.properties.promo.description
This pack is offer with hosting or video

# components.schemas.a57c9d69_Pack.properties.id.description
Unique identifier of the resource `Pack`

# components.schemas.a57c9d69_Periodicity.properties.id.description
Unique identifier of the resource `Periodicity`

# components.schemas.a57c9d69_VodProduct.properties.vod_id.description
Unique identifier of the `vodProduct` that is related to the resource `VodProduct`

# components.schemas.a57c9d69_Account.properties.id.description
Unique identifier of the resource `Account`

# components.schemas.a57c9d69_Account.properties.locale.description
Represents a language identifier and a region identifier

# components.schemas.a57c9d69_Account.properties.language_id.description
Unique identifier of the `language` that is related to the resource `Account`

# components.schemas.a57c9d69_Accountaddress.properties.id.description
Unique identifier of the resource `Account address`

# components.schemas.a57c9d69_Accountaddress.properties.created_at.description
Timestamp `Account address` has been created

# components.schemas.a57c9d69_Tag.properties.product_count.description
Product count related to the resource `Tag`

# components.schemas.a57c9d69_RecordUploadFail.properties.segment_number.description
The segment_number is a numerical identifier used to differentiate the different parts of a record or a fragmented file.

# components.schemas.a57c9d69_RecordUploadFail.properties.uploaded_file_at.description
This date notifies us when we started sending the file toswisstransre

# components.schemas.a57c9d69_Histogramviewersressource.properties.histogram.description
Returns an aggregated histogram of minute,hoour,day,week viewing statistics.

# components.schemas.a57c9d69_Histogramviewersressource.properties.from.description
start date and time for the histogram data range (inclusive).

# components.schemas.a57c9d69_Histogramviewersressource.properties.to.description
End date and time for the histogram data range (inclusive).

# components.schemas.a57c9d69_Resolutionsandhistogramressource.properties.from.description
Timestamp `Resolutions and histogram ressource` from

# components.schemas.a57c9d69_Resolutionsandhistogramressource.properties.to.description
Timestamp `Resolutions and histogram ressource` to

# components.schemas.a57c9d69_Urlressource.properties.player_id.description
Unique identifier of the `player` that is related to the resource `Url ressource`

# components.schemas.a57c9d69_Urlressource.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Url ressource`

# components.schemas.a57c9d69_Options.properties.id.description
Unique identifier of the resource `Options`

# components.schemas.a57c9d69_TranscodingOverlay.properties.name.description
Name of the resource `TranscodingOverlay`

# components.schemas.a57c9d69_TranscodingOverlay.properties.description.description
Description of the resource `TranscodingOverlay`

# components.schemas.a57c9d69_EncoderPreset.properties.stream_id.description
Unique identifier of the `stream` that is related to the resource `EncoderPreset`

# components.schemas.a57c9d69_ChannelsOptionsResource.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Channels Options Resource`

# components.schemas.a57c9d69_RecordsperChannelResource.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Records per Channel Resource`

# components.schemas.a57c9d69_RecordsperChannelResource.properties.name.description
Name of the resource `Records per Channel Resource`

# components.schemas.a57c9d69_DvrsperChannelResource.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Dvrs per Channel Resource`

# components.schemas.a57c9d69_DvrsperChannelResource.properties.name.description
Name of the resource `Dvrs per Channel Resource`

# components.schemas.a57c9d69_Players360perChannelResource.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Players360 per Channel Resource`

# components.schemas.a57c9d69_Players360perChannelResource.properties.name.description
Name of the resource `Players360 per Channel Resource`

# components.schemas.a57c9d69_WatermarksperChannelResource.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Watermarks per Channel Resource`

# components.schemas.a57c9d69_WatermarksperChannelResource.properties.name.description
Name of the resource `Watermarks per Channel Resource`

# components.schemas.a57c9d69_SimulcastperChannelResource_8b1d8cf0.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Simulcast per Channel Resource`

# components.schemas.a57c9d69_HistogramPerChannelResource.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Histogram Per Channel Resource`

# components.schemas.a57c9d69_MultiplesChannelsTechnologiesResource.properties.channel_id.description
Unique identifier of the `channel` that is related to the resource `Multiples Channels Technologies Resource`

# components.schemas.a57c9d69_GlobalChannelConsumptionresource.properties.stream_id.description
Unique identifier of the `stream` that is related to the resource `Global Channel Consumption resource`

# components.schemas.a57c9d69_RecordStorageEvent.properties.id.description
Unique identifier of the record storage event

# components.schemas.a57c9d69_RecordStorageEvent.properties.created_at.description
Date and time when the event was created

# components.schemas.a57c9d69_RecordStorageEvent.properties.updated_at.description
Date and time of the last update of the event

# components.schemas.a57c9d69_RecordStorageEvent.properties.processed.description
Indicates whether the event has been processed

# components.schemas.a57c9d69_RecordStorageEvent.properties.segment_fail.description
The segment that failed if is empty because the file has not been checked.

# components.schemas.daf7713c_SwissBackupSlot.properties.id.description
Unique identifier of the resource `Swiss Backup Slot`

# components.schemas.daf7713c_SwissBackupSlot.properties.customer_name.description
Customer name of the resource `Swiss Backup Slot`

# components.schemas.daf7713c_SwissBackupSlot.properties.type.description
Type of the resource `Swiss Backup Slot`

# components.schemas.daf7713c_SwissBackupSlot.properties.subtype.description
Slot subtype (Arconis or Openstack Swift)

# components.schemas.daf7713c_SwissBackupSlot.properties.size.description
Total storage size of the Swiss Backup product (Bytes)

# components.schemas.daf7713c_SwissBackupSlot.properties.storage_used.description
Used storage size by free storage slots or Acronis backups (Bytes)

# components.schemas.daf7713c_SwissBackupSlot.properties.created_at.description
Timestamp `Swiss Backup Slot` has been created

# components.schemas.daf7713c_SwissBackupSlot.properties.lang.description
Language identifier (1 = fr / 2 = en / 3 = de / 4 = it / 5 = es)

# components.schemas.daf7713c_SwissBackupSlot.properties.activate_notifications.description
True if the user wants to receive Acronis notifications

# components.schemas.daf7713c_Tag.properties.product_count.description
Product count related to the resource `Tag`

# components.schemas.daf7713c_SwissBackup.properties.id.description
Unique identifier of the resource `Swiss Backup`

# components.schemas.daf7713c_SwissBackup.properties.account_id.description
Unique identifier of the `account` that is related to the resource `Swiss Backup`

# components.schemas.daf7713c_SwissBackup.properties.service_id.description
Unique identifier of the `service` that is related to the resource `Swiss Backup`

# components.schemas.daf7713c_SwissBackup.properties.customer_name.description
Customer name of the resource `Swiss Backup`

# components.schemas.daf7713c_SwissBackup.properties.created_at.description
Timestamp `Swiss Backup` has been created

# components.schemas.daf7713c_SwissBackup.properties.deleted_at.description
Timestamp `Swiss Backup` has been deleted

# components.schemas.daf7713c_SwissBackup.properties.has_maintenance.description
Does the resource `Swiss Backup` have a maintenance mode enabled?

# components.schemas.daf7713c_SwissBackup.properties.has_operation_in_progress.description
Does the resource `Swiss Backup` have an operation in progress ?

# components.schemas.daf7713c_SwissBackup.properties.unique_id.description
Unique identifier of the resource `Swiss Backup`

# components.schemas.daf7713c_SwissBackup.properties.description.description
Description of the resource `Swiss Backup`

# components.schemas.daf7713c_SwissBackup.properties.is_free.description
Does the resource `Swiss Backup` have a free price status?

# components.schemas.daf7713c_SwissBackup.properties.is_zero_price.description
Does the resource `Swiss Backup` have a zero price status?

# components.schemas.daf7713c_SwissBackup.properties.is_trial.description
Does the resource `Swiss Backup` have a trial status?

# components.schemas.daf7713c_SwissBackup.properties.nb_slots.description
Total number of slots (Acronis & Free storage)

# components.schemas.daf7713c_SwissBackup.properties.max_slots.description
Total number of authorized slots (Acronis & Free storage)

# components.schemas.daf7713c_SwissBackup.properties.size.description
Total storage size of the Swiss Backup product (Bytes)

# components.schemas.daf7713c_SwissBackup.properties.size_free_storage.description
Allocated storage size for the free storage (Bytes)

# components.schemas.daf7713c_SwissBackup.properties.new_interface.description
True if the product has the new interface

# components.schemas.daf7713c_SwissBackup.properties.storage_reserved_free_storage.description
Allocated storage size for free storage slots (Bytes)

# components.schemas.daf7713c_SwissBackup.properties.storage_reserved_acronis.description
Allocated storage size for Acronis (Bytes)

# components.schemas.daf7713c_SwissBackup.properties.storage_used_free_storage.description
Used storage size by free storage slots (Bytes)

# components.schemas.daf7713c_SwissBackup.properties.storage_used.description
Used storage size by free storage slots or Acronis backups (Bytes)

# components.schemas.daf7713c_SwissBackup.properties.max_slots_free_storage.description
Maximum number of free storage slots allowed

# components.schemas.daf7713c_SwissBackup.properties.max_slots_server.description
Maximum number of Acronis server licences allowed

# components.schemas.daf7713c_SwissBackup.properties.max_slots_virtual.description
Maximum number of Acronis virtual machine licences allowed

# components.schemas.daf7713c_SwissBackup.properties.max_slots_workstation.description
Maximum number of Acronis workstation licences allowed

# components.schemas.daf7713c_SwissBackup.properties.max_slots_mobile.description
Maximum number of Acronis mobile licences allowed

# components.schemas.daf7713c_SwissBackup.properties.nb_slots_virtual.description
Number of Acronis virtual machine licences

# components.schemas.daf7713c_AcronisUsage.properties.nb_slots_virtual.description
Number of Acronis virtual machine licences

# components.schemas.daf7713c_SwissBackupPrice.properties.type.description
Type of the resource `Swiss Backup Price`

# components.schemas.8183272b_Deal.properties.id.description
Unique identifier of the resource `Deal`

# components.schemas.8183272b_Deal.properties.stream_mountpoint.description
The stream mountpoint associate to `Deal`

# components.schemas.8183272b_KubernetesCluster.properties.id.description
Unique identifier of the resource `KubernetesCluster`

# components.schemas.8183272b_KubernetesCluster.properties.name.description
The name of the ressource `KubernetesCluster`

# components.schemas.8183272b_KubernetesCluster.properties.api_url.description
The api url to connect to apply configuration

# components.schemas.8183272b_KubernetesCluster.properties.api_token.description
The `KubernetesCluster` api token for request

# components.schemas.8183272b_KubernetesCluster.properties.namespace.description
The `KubernetesCluster` namespace to request

# components.schemas.8183272b_KubernetesCluster.properties.domain.description
The `KubernetesCluster` domain used for access to the pod

# components.schemas.8183272b_KubernetesCluster.properties.is_enabled.description
Is the resource `KubernetesCluster` enabled?

# components.schemas.8183272b_KubernetesCluster.properties.is_default.description
Is the resource `KubernetesCluster` the default resource?

# components.schemas.8183272b_KubernetesCluster.properties.created_at.description
Timestamp `KubernetesCluster` has been created

# components.schemas.8183272b_KubernetesCluster.properties.updated_at.description
Timestamp `KubernetesCluster` has been updated

# components.schemas.8183272b_ClusterPool.properties.id.description
Unique identifier of the resource `ClusterPool`

# components.schemas.8183272b_ClusterPool.properties.full_name.description
Full name of the ressource `ClusterPool`

# components.schemas.8183272b_Cluster.properties.id.description
Unique identifier of the resource `Cluster`

# components.schemas.8183272b_ClusterConfig.properties.id.description
Unique identifier of the resource `ClusterConfig`

# components.schemas.8183272b_ClusterConfig.properties.clusters.description
The cluster that are using this configuration

# components.schemas.8183272b_ClusterConfig.properties.created_at.description
Timestamp `ClusterConfig` has been created

# components.schemas.8183272b_ClusterConfig.properties.updated_at.description
Timestamp `ClusterConfig` has been updated

# components.schemas.8183272b_ClusterConfig.properties.deleted_at.description
Timestamp `ClusterConfig` has been deleted

# components.schemas.8183272b_Station.properties.id.description
Unique identifier of the resource `Station`

# components.schemas.8183272b_Station.properties.uuid.description
Universally unique identifier of the resource `Station`

# components.schemas.8183272b_Station.properties.thumbnail.description
The url to the thumbnail of the `Station`

# components.schemas.8183272b_Station.properties.log_server.description
The server name to connect to the log server

# components.schemas.8183272b_Station.properties.listeners.description
The number of currently listeners listen all `Stream`

# components.schemas.8183272b_Station.properties.slipping_consumption.description
The current monthly slipping consumption (Byte)

# components.schemas.8183272b_Station.properties.count_active_deal.description
count streams with deals for the station

# components.schemas.8183272b_Station.properties.certified_by.description
Station certified byacpm: Certified by ACPM mediapulse: Certified by Mediapulse indes: Certified like ACPM for the independents

# components.schemas.8183272b_Station.properties.certified_at.description
Last updating date of a certification organisation

# components.schemas.8183272b_Master.properties.id.description
Unique identifier of the resource `Master`

# components.schemas.8183272b_Edge.properties.id.description
Unique identifier of the resource `Edge`

# components.schemas.8183272b_AutoDJ.properties.id.description
Unique identifier of the resource `AutoDJ`

# components.schemas.8183272b_Stream.properties.id.description
Unique identifier of the resource `Stream`

# components.schemas.8183272b_Stream.properties.uuid.description
Universally unique identifier of the resource `Stream`

# components.schemas.8183272b_Stream.properties.mountpoint.description
The mountpoint to access to the `Stream`

# components.schemas.8183272b_Stream.properties.introduction_file_url.description
The audio file used before the `Stream` begin

# components.schemas.8183272b_Stream.properties.ip_include_list.description
The ip list allows to access to the stream

# components.schemas.8183272b_Stream.properties.ip_exclude_list.description
The ip list not allows to access to the stream

# components.schemas.8183272b_Stream.properties.is_allow_country.description
Define if the stream used the restriction rules

# components.schemas.8183272b_Stream.properties.country_list.description
The country list not allows to access to the stream

# components.schemas.8183272b_Stream.properties.is_source.description
Is the `Stream` used for `HlsStream` or `Transcoding` as source?

# components.schemas.8183272b_Stream.properties.listeners.description
The number of currently listeners on `Stream`

# components.schemas.8183272b_Stream.properties.fallback_id.description
The fallback id attached to this `Stream`

# components.schemas.8183272b_HlsStream.properties.use_stream_configuration.description
Used the soundcast stream configuration?

# components.schemas.8183272b_HlsStream.properties.midroll_occurrence.description
The number of secondes between each midroll

# components.schemas.8183272b_HlsStream.properties.is_metadata_midroll.description
Is the metadata detection are enabled for midroll?

# components.schemas.8183272b_HlsStream.properties.is_overwrite_midroll.description
Is the overwrite mode are enabled for midroll?

# components.schemas.8183272b_HlsStream.properties.id.description
Unique identifier of the resource `HlsStream`

# components.schemas.8183272b_HlsStream.properties.uuid.description
Universally unique identifier of the resource `HlsStream`

# components.schemas.8183272b_HlsStream.properties.buffer_size.description
The size of the buffer in the `HlsStream`

# components.schemas.8183272b_HlsStream.properties.fragment_size.description
The size of the fragment in the `HlsStream` use for buffer size

# components.schemas.8183272b_HlsStream.properties.ip_include_list.description
The ip list allows to access to the hls stream

# components.schemas.8183272b_HlsStream.properties.ip_exclude_list.description
The ip list not allows to access to the hls stream

# components.schemas.8183272b_HlsStream.properties.is_allow_country.description
Define if the hls stream used the restriction rules

# components.schemas.8183272b_HlsStream.properties.country_list.description
The country list not allows to access to the hls stream

# components.schemas.8183272b_HlsStream.properties.listeners.description
The number of currently listeners on `HlsStream`

# components.schemas.8183272b_Player.properties.display_name.description
Name of the ressource `Player` visible by final customer

# components.schemas.8183272b_Player.properties.is_metadata_display.description
Is the metadata title and artist displayed?

# components.schemas.8183272b_Player.properties.height.description
The height used for render the `Player` (px)

# components.schemas.8183272b_Player.properties.width.description
The width used for render the `Player` (px)

# components.schemas.8183272b_Player.properties.background_color.description
The background color used in the `Player`

# components.schemas.8183272b_Player.properties.secondary_color.description
The secondary color used in the `Player`

# components.schemas.8183272b_Player.properties.is_listeners.description
Is the listeners informations displayed?

# components.schemas.8183272b_Player.properties.listeners_hold.description
The listeners hold used to display listeners informations

# components.schemas.8183272b_Player.properties.facebook_link.description
The Facebook link used to Facebook embed

# components.schemas.8183272b_Player.properties.twitter_account.description
The Twitter account used to Twitter embed

# components.schemas.8183272b_Player.properties.twitter_backlink.description
The Twitter backlink used to Twitter embed

# components.schemas.8183272b_Player.properties.twitter_hashtag.description
The Twitter hashtag used to Twitter embed

# components.schemas.8183272b_Player.properties.loading.description
The url of the loading file used in the player

# components.schemas.8183272b_Player.properties.unavailable.description
The url of the unavailable file used in the player

# components.schemas.8183272b_Player.properties.restriction.description
The url of the restriction file used in the player

# components.schemas.8183272b_Player.properties.is_hls_buffered.description
Is the player start at the beginning and buffer hls streams?

# components.schemas.8183272b_Player.properties.history_display.description
The history display used in the `Player`

# components.schemas.8183272b_Player.properties.is_history_time_display.description
Is the history player time will be display ?

# components.schemas.8183272b_Player.properties.is_history_clickable.description
Is the history player could be clickable ?

# components.schemas.8183272b_Player.properties.id.description
Unique identifier of the resource `Player`

# components.schemas.8183272b_Player.properties.uuid.description
Universally unique identifier of the resource `Player`

# components.schemas.8183272b_CustomField.properties.cluster_pool_id.description
Unique identifier of the resource `ClusterPool`

# components.schemas.8183272b_CustomField.properties.created_at.description
Timestamp `CustomField` has been created

# components.schemas.8183272b_CustomField.properties.updated_at.description
Timestamp `CustomField` has been updated

# components.schemas.8183272b_BatchClusterMigration.properties.id.description
Unique identifier of the resource `BatchClusterMigration`

# components.schemas.8183272b_StationHistory.properties.one_day_old_stations.description
Count of stations created during last day

# components.schemas.8183272b_StationHistory.properties.one_week_old_station.description
Count of stations created during last week

# components.schemas.8183272b_StationHistory.properties.two_weeks_old_station.description
Count of stations created during last two weeks

# components.schemas.8183272b_StationHistory.properties.one_month_old_station.description
Count of stations created during last month

# components.schemas.8183272b_StationHistory.properties.three_month_old_station.description
Count of stations created during last three month

# components.schemas.8183272b_Pack.properties.id.description
Unique identifier of the resource `Pack`

# components.schemas.8183272b_Pack.properties.max_bitrate.description
The max bitrate can be used for create a `Stream` (KiloBit)

# components.schemas.8183272b_Pack.properties.max_bandwidth.description
The max bandwidth can be used in total of all `Station`(Byte)

# components.schemas.8183272b_Pack.properties.max_free_autodj_size.description
The max free AutoDJ space can be used in VOD (GigaByte)

# components.schemas.8183272b_PackPrice.properties.id.description
Unique identifier of the resource `PackPrice`

# components.schemas.8183272b_PackPrice.properties.periodicity_id.description
Unique identifier of the resource `Periodicity`

# components.schemas.8183272b_Station_e0573969.properties.id.description
Unique identifier of the resource `Station`

# components.schemas.8183272b_Station_e0573969.properties.thumbnail.description
The url to the thumbnail of the `Station`

# components.schemas.8183272b_StreamSimplify.properties.id.description
Unique identifier of the resource `Stream`

# components.schemas.8183272b_StreamSimplify.properties.is_source.description
Define if the stream is used like a source for HlsStream or Transcoding

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.use_stream_configuration.description
Used the soundcast stream configuration?

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.midroll_occurrence.description
The number of secondes between each midroll

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.is_metadata_midroll.description
Is the metadata detection are enabled for midroll?

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.is_overwrite_midroll.description
Is the overwrite mode are enabled for midroll?

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.id.description
Unique identifier of the resource `HlsStreamForMetadataApi`

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.fragment_size.description
The size of the fragment in the `HlsStream`

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.station_id.description
The station id attached to this `HlsStream`

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.source_codec.description
The source `Stream` codec of the `HlsStream`

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.preroll_tag.description
The source `Stream` custom fields of the `HlsStream`

# components.schemas.8183272b_HlsStreamForMetadataApi.properties.midroll_tag.description
The source `Stream` custom fields of the `HlsStream`

# components.schemas.8183272b_StreamForMetadataApi.properties.id.description
Unique identifier of the resource `StreamForMetadataApi`

# components.schemas.8183272b_StreamForMetadataApi.properties.mountpoint.description
The mountpoint to access to the `Stream`

# components.schemas.8183272b_StreamForMetadataApi.properties.station_id.description
The station id attached to this `Stream`

# components.schemas.8183272b_StreamForMetadataApi.properties.subdomain.description
The station subdomain attached to this `Stream`

# components.schemas.8183272b_StreamForMetadataApi.properties.cluster_id.description
The cluster id attached to this `Stream`

# components.schemas.8183272b_Option.properties.id.description
Unique identifier of the resource `Option`

# components.schemas.8183272b_OptionPrice.properties.id.description
Unique identifier of the resource `OptionPrice`

# components.schemas.8183272b_PlayerConfiguration.properties.artist.description
The current artist name of the played music

# components.schemas.8183272b_PlayerConfiguration.properties.background_color.description
The background color used in the `Player`

# components.schemas.8183272b_PlayerConfiguration.properties.cover.description
The current cover url of the played music

# components.schemas.8183272b_PlayerConfiguration.properties.display_name.description
Name of the ressource `Player` visible by final customer

# components.schemas.8183272b_PlayerConfiguration.properties.facebook_link.description
The Facebook link used to Facebook embed

# components.schemas.8183272b_PlayerConfiguration.properties.height.description
The height used for render the `Player` (px)

# components.schemas.8183272b_PlayerConfiguration.properties.history_display.description
The history display used in the `Player`

# components.schemas.8183272b_PlayerConfiguration.properties.id.description
Unique identifier of the resource `Player`

# components.schemas.8183272b_PlayerConfiguration.properties.is_history_clickable.description
Is the history player could be clickable ?

# components.schemas.8183272b_PlayerConfiguration.properties.is_history_time_display.description
Is the history player time will be display ?

# components.schemas.8183272b_PlayerConfiguration.properties.is_listeners.description
Is the listeners informations displayed?

# components.schemas.8183272b_PlayerConfiguration.properties.is_metadata_display.description
Is the metadata title and author is enabled?

# components.schemas.8183272b_PlayerConfiguration.properties.is_station_thumbnail.description
Is the station thumbnail we be displayed like cover?

# components.schemas.8183272b_PlayerConfiguration.properties.is_hls_buffered.description
Is the player start at the beginning and buffer hls streams?

# components.schemas.8183272b_PlayerConfiguration.properties.listeners.description
The current number of listeners on the station

# components.schemas.8183272b_PlayerConfiguration.properties.listeners_hold.description
The minimum number of listeners to display listeners

# components.schemas.8183272b_PlayerConfiguration.properties.loading.description
The url of the loading file used in the player

# components.schemas.8183272b_PlayerConfiguration.properties.restriction.description
The url of the restriction file used in the player

# components.schemas.8183272b_PlayerConfiguration.properties.secondary_color.description
The secondary color used in the `Player`

# components.schemas.8183272b_PlayerConfiguration.properties.timeline.description
The list of last songs played on the station

# components.schemas.8183272b_PlayerConfiguration.properties.title.description
The current artist title of the played music

# components.schemas.8183272b_PlayerConfiguration.properties.twitter_account.description
The Twitter account used to Twitter embed

# components.schemas.8183272b_PlayerConfiguration.properties.twitter_backlink.description
The Twitter backlink used to Twitter embed

# components.schemas.8183272b_PlayerConfiguration.properties.twitter_hashtag.description
The Twitter hashtag used to Twitter embed

# components.schemas.8183272b_PlayerConfiguration.properties.unavailable.description
The url of the unavailable file used in the player

# components.schemas.8183272b_PlayerConfiguration.properties.width.description
The width used for render the `Player` (px)

# components.schemas.8183272b_RadioProduct.properties.locked_at.description
Timestamp `RadioProduct` has been locked

# components.schemas.8183272b_RadioProduct.properties.has_maintenance.description
Does the resource `RadioProduct` have a maintenance mode enabled?

# components.schemas.8183272b_RadioProduct.properties.listeners.description
The number of currently listeners listen all `Stream`

# components.schemas.8183272b_RadioProduct.properties.count_active_deal.description
count stations with deals for the radio_product

# components.schemas.8183272b_RadioProduct.properties.created_at.description
Timestamp `RadioProduct` has been created

# components.schemas.8183272b_RadioProduct.properties.updated_at.description
Timestamp `RadioProduct` has been updated

# components.schemas.8183272b_RadioProduct.properties.deleted_at.description
Timestamp `RadioProduct` has been deleted

# components.schemas.8183272b_RadioProductOptionShop.properties.id.description
Unique identifier of the resource `RadioProductOptionShop`

# components.schemas.8183272b_RadioProductOptionShop.properties.type.description
Type of the resource `RadioProductOptionShop`

# components.schemas.8183272b_User.properties.id.description
Unique identifier of the resource `User`

# components.schemas.8183272b_StatListener.properties.listeners_30s.description
The number of listeners will stay 30 seconds

# components.schemas.8183272b_StatListener.properties.sub_unique_listeners.description
The number of unique listeners for the sub model(Station or Stream)

# components.schemas.8183272b_StatListener.properties.listening_time_30s.description
The number of seconds listened with listener stay at least 30 seconds

# components.schemas.8183272b_StatCountry.properties.streams.description
The list of streams call in this country (only available on stations stats)

# components.schemas.8183272b_StatCountry.properties.stations.description
The list of stations call in this country (only available on radio products stats)

# components.schemas.8183272b_StatCountry.properties.listeners_30s.description
The number of listeners who stay more than 30 secondes

# components.schemas.8183272b_StatCountry.properties.average_listeners_30s_by_day.description
The number of listeners per day who stay more than 30 secondes

# components.schemas.8183272b_ContinentMetric.properties.SA.description
The number of listeners in South America

# components.schemas.8183272b_ContinentMetric.properties.NA.description
The number of listeners in North America

# components.schemas.8183272b_StatListenerByStation.properties.listeners_30s.description
The number of listeners will stay 30 seconds

# components.schemas.8183272b_StatListenerByStation.properties.average_listening_time.description
The average of seconds listened on the date range

# components.schemas.8183272b_StatConsumption.properties.average_bytes_by_listeners.description
The average of bytes consumed by listener

# components.schemas.8183272b_StatConsumptionByStream.properties.total_bytes.description
The total of bytes consumed on the date range

# components.schemas.8183272b_StatConsumptionByStream.properties.average_bytes_by_listeners.description
The average of bytes consumed by listeners

# components.schemas.8183272b_StatTotalPlayer.properties.streams.description
The list of streams use this player (only available on stations stats)

# components.schemas.8183272b_StatTotalPlayer.properties.stations.description
The list of stations use this player (only available on radio products stats)

# components.schemas.8183272b_StatTotalPlayer.properties.percent_listeners.description
The percent of listeners of the player total

# components.schemas.8183272b_StatListLink.properties.status.description
The url link to call to get status on each streams

# components.schemas.8183272b_StatListLink.properties.status_per_stream.items.description
The url list to call to get status stream

# components.schemas.8183272b_StatListLink.properties.status_per_stream.description
The url list to call to get status stream

# components.schemas.8183272b_StatListLink.properties.instant_customer.description
The url link to call to get number of listeners on each streams

# components.schemas.8183272b_StatListLink.properties.instant_customer_per_stream.items.description
The url list to call to get number of listeners on stream

# components.schemas.8183272b_StatListLink.properties.instant_customer_per_stream.description
The url list to call to get number of listeners on stream

# components.schemas.8183272b_StatListLink.properties.mediastats_per_stream.items.description
The url list to call to get mediastats on stream

# components.schemas.8183272b_StatListLink.properties.mediastats_per_stream.description
The url list to call to get mediastats on stream

# components.schemas.8183272b_StatListLink.properties.update_metadata.description
The url link to call to change metadata of your station

# components.schemas.8183272b_Notification.properties.is_monday.description
Is the users can be notified the monday ?

# components.schemas.8183272b_Notification.properties.is_tuesday.description
Is the users can be notified the tuesday ?

# components.schemas.8183272b_Notification.properties.is_wednesday.description
Is the users can be notified the wednesday ?

# components.schemas.8183272b_Notification.properties.is_thursday.description
Is the users can be notified the thursday ?

# components.schemas.8183272b_Notification.properties.is_friday.description
Is the users can be notified the friday ?

# components.schemas.8183272b_Notification.properties.is_saturday.description
Is the users can be notified the saturday ?

# components.schemas.8183272b_Notification.properties.is_sunday.description
Is the users can be notified the sunday ?

# components.schemas.8183272b_PlayingMedia.properties.id.description
Unique identifier of the resource `PlayingMedia`

# components.schemas.8183272b_PlayingMedia.properties.is_under_live.description
The `PlayingMedia` will be played if live stream is not on

# components.schemas.8183272b_PlayingMedia.properties.has_perfect_timing.description
The `PlayingMedia` will be played at the exact started_at

# components.schemas.8183272b_PlanningEvent.properties.id.description
Unique identifier of the resource `PlanningEvent`

# components.schemas.8183272b_Media.properties.artists.description
The time before the same song can be replayed

# components.schemas.8183272b_Media.properties.cover.description
The time before the same song can be replayed

# components.schemas.8183272b_Media.properties.duration.description
The time before the same song can be replayed

# components.schemas.8183272b_StatListenerByStation_21e42669.properties.listeners_30s.description
The number of listeners will stay 30 seconds

# components.schemas.8183272b_StatListenerByStation_21e42669.properties.average_listening_time.description
The average of seconds listened on the date range

# components.schemas.8183272b_StatConsumptionByStation.properties.total_bytes.description
The total of bytes consumed on the date range

# components.schemas.8183272b_StatConsumptionByStation.properties.average_bytes_by_listeners.description
The average of bytes consumed by listeners

# components.schemas.8183272b_StreamMaster.properties.id.description
Unique identifier of the resource `StreamMaster`

# components.schemas.8183272b_StreamMaster.properties.uuid.description
Universally unique identifier of the resource `StreamMaster`

# components.schemas.8183272b_Station_1dfd1c4c.properties.id.description
Unique identifier of the resource `Station`

# components.schemas.8183272b_Station_1dfd1c4c.properties.thumbnail.description
The url to the thumbnail of the `Station`

# components.schemas.8183272b_Station_1dfd1c4c.properties.streams.description
The list of streams with relay and transcoded streams

# components.schemas.8183272b_StreamStored.properties.id.description
Unique identifier of the resource `Stream`

# components.schemas.8183272b_StreamStored.properties.fallback_mountpoint.description
The mountpoint used to fallback the stream

# components.schemas.8183272b_StreamStored.properties.is_source.description
Define if the stream is used like a source for HlsStream or Transcoding

# components.schemas.8183272b_StreamStored.properties.is_transcoding.description
Define if the stream is a transcoded stream

# components.schemas.1a4921f4_PublicCloud.properties.id.description
Unique identifier of the resource `Public Cloud`

# components.schemas.1a4921f4_PublicCloud.properties.account_id.description
Unique identifier of the `account` that is related to the resource `Public Cloud`

# components.schemas.1a4921f4_PublicCloud.properties.service_id.description
Unique identifier of the `service` that is related to the resource `Public Cloud`

# components.schemas.1a4921f4_PublicCloud.properties.customer_name.description
Customer name of the resource `Public Cloud`

# components.schemas.1a4921f4_PublicCloud.properties.created_at.description
Timestamp `Public Cloud` has been created

# components.schemas.1a4921f4_PublicCloud.properties.deleted_at.description
Timestamp `Public Cloud` has been deleted

# components.schemas.1a4921f4_PublicCloud.properties.has_maintenance.description
Does the resource `Public Cloud` have a maintenance mode enabled?

# components.schemas.1a4921f4_PublicCloud.properties.has_operation_in_progress.description
Does the resource `Public Cloud` have an operation in progress?

# components.schemas.1a4921f4_PublicCloud.properties.unique_id.description
Unique identifier of the resource `Public Cloud`

# components.schemas.1a4921f4_PublicCloud.properties.description.description
Description of the resource `Public Cloud`

# components.schemas.1a4921f4_PublicCloud.properties.is_free.description
Does the resource `Public Cloud` have a free price status?

# components.schemas.1a4921f4_PublicCloud.properties.is_zero_price.description
Does the resource `Public Cloud` have a zero price status?

# components.schemas.1a4921f4_PublicCloud.properties.is_trial.description
Does the resource `Public Cloud` have a trial status?

# components.schemas.1a4921f4_PublicCloud.properties.public_cloud_id.description
Unique identifier of a Public Cloud product

# components.schemas.1a4921f4_PublicCloud.properties.public_cloud.description
This object contains information specific to the public cloud

# components.schemas.1a4921f4_Tag.properties.product_count.description
Product count related to the resource `Tag`

# components.schemas.1a4921f4_KubernetesServicePack.properties.kaas_pack_id.description
Kubernetes Service Pack unique identifier

# components.schemas.1a4921f4_KubernetesServicePack.properties.price_per_hour.description
Current Kubernetes Service Pack price per hour of usage

# components.schemas.1a4921f4_KubernetesServicePack.properties.limit_per_project.description
The maximum number of Kubernetes Services of the given pack per project. null = unlimited

# components.schemas.1a4921f4_KubernetesServicePack.properties.is_active.description
Is the pack currently active for use in Kubernetes Service creations

# components.schemas.1a4921f4_DatabaseService.properties.backups.description
The backup list for the given Database Service

# components.schemas.1a4921f4_DatabaseService.properties.last_backup_at.description
The timestamp of the latest backup for the given Database Service

# components.schemas.1a4921f4_DatabaseService.properties.total_backup_size.description
The size in bytes of every backup for the given Database Service

# components.schemas.1a4921f4_DatabaseService.properties.slow_logs_enabled.description
Are slow logs enabled for this Database Service

# components.schemas.1a4921f4_DatabaseServicePack.properties.instances.description
The number of instances in this Database Service pack

# components.schemas.1a4921f4_DatabaseServicePack.properties.cpu.description
The number of vCPUs in this Database Service pack

# components.schemas.1a4921f4_DatabaseServicePack.properties.ram.description
The amount of RAM in this Database Service pack

# components.schemas.1a4921f4_DatabaseServicePack.properties.storage.description
The amount of storage in this Database Service pack

# components.schemas.1a4921f4_DatabaseServiceBackupSchedule.properties.scheduled_at.description
Backup schedule time in format H:i (24 hour, UTC)

# components.schemas.1a4921f4_DatabaseServiceBackupSchedule.properties.retention.description
The number of backups to keep for this schedule

# components.schemas.1a4921f4_DatabaseServiceBackupSchedule.properties.is_pitr_enabled.description
Is point in time recovery enabled or disabled

# components.schemas.1a4921f4_DatabaseServiceBackup.properties.id.description
Unique identifier of the resource `Database Service Backup`

# components.schemas.1a4921f4_DatabaseServiceBackup.properties.created_at.description
Timestamp `Database Service Backup` has been created

# components.schemas.1a4921f4_DatabaseServiceBackup.properties.status.description
Status of the resource `Database Service Backup`

# components.schemas.1a4921f4_PublicCloudConfig.properties.free_tier.description
Free tier amount limit, unit is your account currency

# components.schemas.1a4921f4_PublicCloudConfig.properties.free_tier_used.description
Free tier amount consumed, unit is your account currency

# components.schemas.1a4921f4_PublicCloudConfig.properties.valid_from.description
Date since which the configuration is valid

# components.schemas.1a4921f4_KubernetesServiceFlavor.properties.cpu.description
How many CPUs are included in the flavor

# components.schemas.1a4921f4_KubernetesServiceFlavor.properties.ram.description
How much memory is included in the flavor

# components.schemas.1a4921f4_KubernetesServiceFlavor.properties.storage.description
How much storage is included in the flavor

# components.schemas.1a4921f4_KubernetesServiceFlavor.properties.is_available.description
Is the flavor available to use for this project

# components.schemas.1a4921f4_InstancePool.properties.flavor.description
Instances will be created using this flavor

# components.schemas.1a4921f4_InstancePool.properties.minimum_instances.description
Minimum instances, fixed or with autoscaling

# components.schemas.1a4921f4_InstancePool.properties.maximum_instances.description
Maximum instances, used with autoscaling

# components.schemas.1a4921f4_InstancePool.properties.target_instances.description
The number of instances currently targeted for use

# components.schemas.1a4921f4_InstancePool.properties.available_instances.description
The number of instances that are available for use. When available_instances = target_instances all instances are ready

# components.schemas.1a4921f4_InstancePool.properties.has_autoscaling.description
Does this instance pool have autoscaling

# components.schemas.1a4921f4_InstancePool.properties.labels.description
A list of labels that are applied to the Kubernetes Instances

# components.schemas.1a4921f4_InstancePool.properties.rollout_after.description
Date after which all machines in this pool may receive a rollout, and get restarted as a result (RFC3339 format, e.g. 2026-09-09T09:00:00Z)

# components.schemas.1a4921f4_DatabaseServiceRestore.properties.id.description
Unique identifier of the resource `Database Service Restore`

# components.schemas.1a4921f4_DatabaseServiceRestore.properties.created_at.description
Timestamp `Database Service Restore` has been created

# components.schemas.1a4921f4_DatabaseServiceRestore.properties.status.description
Status of the resource `Database Service Restore`

# components.schemas.1a4921f4_DatabaseServiceLog.properties.timestamp.description
The logs date and time [format: timestamp]

# components.schemas.1a4921f4_PublicCloudInfo.properties.project_icu.description
Infomaniak internal unit of price measure

# components.schemas.1a4921f4_PublicCloudInvitationNormalizer.properties.public_cloud_id.description
Unique identifier of a Public Cloud product

# components.schemas.1a4921f4_PublicCloudInvitationNormalizer.properties.public_cloud_user_id.description
Unique identifier of a Public Cloud user

# components.schemas.1a4921f4_PublicCloudInvitationNormalizer.properties.invited_by.description
Unique identifier of the user at the origin of the invitation

# components.schemas.1a4921f4_DatabaseServiceConnection.properties.host.description
The host to use to connect to the Database Service

# components.schemas.1a4921f4_DatabaseServiceConnection.properties.port.description
The port to use to connect to the Database Service

# components.schemas.1a4921f4_DatabaseServiceConnection.properties.user.description
The user to use to connect to the Database Service

# components.schemas.1a4921f4_DatabaseServiceConnection.properties.password.description
The password to use to connect to the Database Service

# components.schemas.1a4921f4_DatabaseServiceConnection.properties.uri.description
The uri that can be used to connect to the Database Service

# components.schemas.1a4921f4_DatabaseServiceConnection.properties.command.description
The command that can be used to connect to the Database Service

# components.schemas.1a4921f4_DatabaseServiceConnection.properties.ca.description
The CA that is used by the connection to the Database Service

# components.schemas.93e74a89_CreatedorUpdatedBimi.properties.status.description
Status of the resource `Created or Updated Bimi`

# components.schemas.93e74a89_CreatedorUpdatedBimi.properties.state.description
Indicates the current state of the BIMI (Brand Indicators for Message Identification) associated with a mail service.certified: The BIMI is certified and valid. The brand logo will be displayed in supported email clients. error: An error occurred with the BIMI setup. The brand logo will not be displayed, and further investigation is needed. expired: The BIMI certification has expired. The brand logo will not be displayed until the certification is renewed. not_certified: The BIMI is not certified. The brand logo may not appear in many email clients.

# components.schemas.93e74a89_CreatedorUpdatedBimi.properties.svg_uri.description
The URL of the SVG image associated with the BIMI record

# components.schemas.93e74a89_CreatedorUpdatedBimi.properties.vmc_uri.description
The URL of the VMC (Verified Mark Certificate) associated with the BIMI record

# components.schemas.93e74a89_CreatedorUpdatedBimi.properties.current.description
The current DNS record for the BIMI, including the version, SVG link, and VMC link

# components.schemas.93e74a89_SignatureTemplate.properties.id.description
Unique identifier of the resource `Signature Template`

# components.schemas.93e74a89_SignatureTemplate.properties.name.description
Name of the resource `Signature Template`

# components.schemas.93e74a89_SignatureTemplate.properties.status.description
Specifies the current status of the signature template. The signature can either be enabled and ready for use, or in draft mode awaiting validation.draft: The signature is in draft mode and cannot be used until it has been validated. enabled: The signature is enabled and available for use in emails.

# components.schemas.93e74a89_SignatureTemplateCreator.properties.id.description
Unique identifier of the resource `Signature Template Creator`

# components.schemas.93e74a89_SignatureTemplateCreator.description
The signature template creator information

# components.schemas.93e74a89_ImageURL.properties.image.description
The url where you can retrieve the stored image.

# components.schemas.93e74a89_ServiceMailResponder.properties.id.description
Unique identifier of the resource `Service Mail Responder`

# components.schemas.93e74a89_ServiceMailResponder.properties.is_visible.description
Tells if the responder is visible for the other users of the mail service

# components.schemas.93e74a89_ServiceMailResponder.properties.dont_reply_to.items.description
Emails that aren't concerned with the responder

# components.schemas.93e74a89_ServiceMailResponder.properties.dont_reply_to.description
Emails that aren't concerned with the responder

# components.schemas.93e74a89_ServiceMailResponder.properties.reply_from_id.description
Id of the Email that send the auto reply

# components.schemas.93e74a89_ValidEmail.properties.id.description
Unique identifier of the resource `Valid Email`

# components.schemas.93e74a89_ValidEmail.properties.email_idn.description
Mail with special character like é or other

# components.schemas.93e74a89_ServiceMailboxSieveFilter.properties.id.description
Unique identifier of the resource `Service Mailbox Sieve Filter`

# components.schemas.93e74a89_CreatedMailbox.properties.quota.description
The limit of memory associated with the mail service in Mo

# components.schemas.93e74a89_CreatedMailbox.properties.used.description
The current number of mailboxes on the service

# components.schemas.93e74a89_CreatedMailbox.properties.total.description
The total number of mailboxes that service can have

# components.schemas.93e74a89_Mailbox.properties.size.description
Display the size of the mailbox, should be displayed when with=size or when with=size_refresh(this activate the recalculation, forced when this was more then 3 months

# components.schemas.93e74a89_Mailbox.properties.size_checked_at.description
This indicates the last time the size was calculated by the system. Should be display with the argument with=size_refresh or with=size

# components.schemas.93e74a89_Mailbox.properties.external_mail_flag_enabled.description
Indicates if the mailbox has the option to mark mail from external provider activated

# components.schemas.93e74a89_UserV2.properties.id.description
Unique identifier of the resource `UserV2`

# components.schemas.93e74a89_Team.properties.id.description
Unique identifier of the resource `Team`

# components.schemas.93e74a89_Team.properties.color_id.description
Unique identifier of the `color` of the resource `Team`

# components.schemas.93e74a89_Team.properties.owned_by_id.description
Unique identifier of the `user` that owned the resource `Team`

# components.schemas.93e74a89_Team.properties.created_by_id.description
Unique identifier of the `user` that created the resource `Team`

# components.schemas.93e74a89_Team.properties.user_count.description
User count related to the resource `Team`

# components.schemas.93e74a89_Team.properties.product_count.description
Product count related to the resource `Team`

# components.schemas.93e74a89_Team.properties.product_by_service_count.description
Product by service count related to the resource `Team`

# components.schemas.93e74a89_User.properties.id.description
Unique identifier of the resource `User`

# components.schemas.93e74a89_Mailinglist.properties.mail.description
The mail that is used to send the email to the subscriber

# components.schemas.93e74a89_Mailinglist.properties.user_count.description
The number of subscriber associated with the mailing list

# components.schemas.93e74a89_Mailinglist.properties.being_deleted.description
Indicates if the mailing list is in the process to be deleted

# components.schemas.93e74a89_Mailinglist.properties.welcome_message.description
The message sent when someone is a new subscriber

# components.schemas.93e74a89_Mailinglist.properties.goodbye_message.description
The message sent when someone unsubscribes from the mailing list

# components.schemas.93e74a89_Mailinglist.properties.moderator.description
Emails of all the moderators of the mailing list

# components.schemas.93e74a89_Mailinglistconfig.properties.use_reply_to.description
Says if we use the reply-to address when we reply to the mailing list

# components.schemas.93e74a89_Mailinglistconfig.properties.is_reply_to_forced.description
Says if the email of the sender is the reply-to when responding to the mailing list

# components.schemas.93e74a89_Mailinglistconfig.properties.who_can_send.description
Indicates who can send mails in the mailing list.0: Only moderator and subscriber can send email through the mailing list. 1: Only moderator can send email through the mailing list. 2: Everyone can send email through the mailing list but requires a moderator validation. 3: Only moderator and subscriber can send email through the mailing list but requires a moderator validation. 4: Everyone can send a mail through the mailing list but requires a moderator validation for the mail sent by non subscribers. 5: Everyone can send a mail through the mailing list.

# components.schemas.93e74a89_Mailinglistconfig.properties.who_can_subscribe.description
The subscription policy setup for the mailing list.0: Anybody can subscribe. 1: Any new subscription should be confirmed by the owner. 2: Any new subscription should be confirmed by the owner and the subscriber.

# components.schemas.93e74a89_Mailinglistconfig.properties.lang.description
Current language preference code.de: German language. en: English language. es: Spanish language. fr: French language. it: Italian language.

# components.schemas.93e74a89_Mailinglistconfig.properties.should_send_notifications.description
Indicates if the mailing list should send notifications

# components.schemas.93e74a89_Mailinglistmoderator.properties.mail.description
Email address that identifies a moderator

# components.schemas.93e74a89_Mailservicecurrentlyunavailableforcauseofswap.title
Mail service currently unavailable for cause of swap

# components.schemas.93e74a89_MailboxSieveFilter.properties.prevent_script.description
Indicates if your account can use script or not

# components.schemas.93e74a89_MailboxSieveFilter.properties.use_scripts.description
Indicates if the mailbox use script or base filter

# components.schemas.93e74a89_MailboxFilter.properties.is_enabled.description
Indicates if the mailbox filter is enabled

# components.schemas.93e74a89_MailboxFilter.properties.has_all_of.description
Indicates if the filter has to complete all the condition to be activated or just one

# components.schemas.93e74a89_MailboxFilter.properties.conditions.description
List of condition to activate the filter

# components.schemas.93e74a89_MailboxFilter.properties.actions.description
List of actions to do when the filter is activated

# components.schemas.93e74a89_MailboxFilter.properties.template_id.description
The identifier of the template to use if it is wanted

# components.schemas.93e74a89_Signature.properties.id.description
Unique identifier of the resource `Signature`

# components.schemas.93e74a89_Signature.properties.position.description
Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.bottom: The signature is placed at the bottom of the email. top: The signature is placed at the top of the email.

# components.schemas.93e74a89_SignatureUserAccess.properties.id.description
Unique identifier of the resource `Signature User Access`

# components.schemas.93e74a89_MailboxSignature.properties.position.description
Specifies the position of the signature in an email. The signature can be placed either at the top or at the bottom of the email content.bottom: The signature is placed at the bottom of the email. top: The signature is placed at the top of the email.

# components.schemas.93e74a89_CreateForwardingResponse.properties.email_idn.description
Mail with special character like é or other

# components.schemas.93e74a89_CreateForwardingResponse.properties.has_dont_deliver.description
Indicates if the mailbox should delete emails locally after forwarding them

# components.schemas.93e74a89_MailboxRedirection.properties.has_dont_deliver.description
Indicates if the mailbox should delete emails locally after forwarding them

# components.schemas.93e74a89_MailboxRedirection.properties.has_forward_spam.description
Indicates if the mailbox should forward mail that are considered to be spam

# components.schemas.93e74a89_RedirectionAddress.properties.email_idn.description
Mail with special character like é or other

# components.schemas.93e74a89_Redirection.properties.id.description
Unique identifier of the resource `Redirection`

# components.schemas.93e74a89_Redirection.properties.created_at.description
Timestamp `Redirection` has been created

# components.schemas.93e74a89_Redirection.properties.updated_at.description
Timestamp `Redirection` has been updated

# components.schemas.93e74a89_RedirectionTarget.properties.id.description
Unique identifier of the resource `Redirection Target`

# components.schemas.93e74a89_RedirectionTarget.properties.created_at.description
Timestamp `Redirection Target` has been created

# components.schemas.93e74a89_RedirectionTarget.properties.updated_at.description
Timestamp `Redirection Target` has been updated

# components.schemas.93e74a89_RedirectionAddress_fc08f222.properties.id.description
Unique identifier of the resource `Redirection Address`

# components.schemas.93e74a89_RedirectionAddress_fc08f222.properties.created_at.description
Timestamp `Redirection Address` has been created

# components.schemas.93e74a89_RedirectionAddress_fc08f222.properties.updated_at.description
Timestamp `Redirection Address` has been updated

# components.schemas.93e74a89_UserAccess.properties.id.description
Unique identifier of the resource `User Access`

# components.schemas.93e74a89_UserAccess.properties.status.description
Specifies the status of the access.healthy: The access is healthy. new: The access is new. spam: The access was sending spam.

# components.schemas.93e74a89_UserAccess.properties.created_at.description
Timestamp `User Access` has been created

# components.schemas.93e74a89_TeamAccess.properties.id.description
Unique identifier of the resource `Team Access`

# components.schemas.93e74a89_TeamAccess.properties.created_at.description
Timestamp `Team Access` has been created

# components.schemas.93e74a89_Device.properties.id.description
Unique identifier of the resource `Device`

# components.schemas.93e74a89_Device.properties.type.description
Specifies the type of the device.computer: The device is a computer. legacy: The device'password is a legacy password used by all users before the feature of multiples password. other: The device is an other type. phone: The device is a phone. tablet: The device is a tablet.

# components.schemas.93e74a89_DeviceAccess.properties.id.description
Unique identifier of the resource `Device Access`

# components.schemas.93e74a89_DeviceAccess.properties.protocols.description
Specifies the protocol of the access. By default, all protocol choices include smtp protocol.imap: The protocol is imap. pop3: The protocol is pop3. pop3-imap: The protocol is imap and pop3.

# components.schemas.93e74a89_DeviceAccess.properties.created_at.description
Timestamp `Device Access` has been created

# components.schemas.93e74a89_DeviceAccess.properties.status.description
Specifies the status of the access.healthy: The password is healthy. leaked: The password was leaked. spam: The password was sending spam.

# components.schemas.93e74a89_ServiceMailpreferences.properties.created_at.description
Timestamp `Service Mail preferences` has been created

# components.schemas.93e74a89_ServiceMailpreferences.properties.updated_at.description
Timestamp `Service Mail preferences` has been updated

# components.schemas.93e74a89_Actionbatch.properties.id.description
Unique identifier of the resource `Action batch`

# components.schemas.93e74a89_Actionbatch.properties.created_at.description
Timestamp `Action batch` has been created

# components.schemas.93e74a89_Mailboxlog.properties.id.description
Unique identifier of the resource `Mailbox log`

# components.schemas.93e74a89_Mailboxlogmessageresponse.properties.status.description
Status of the resource `Mailbox log message response`

# components.schemas.93e74a89_Responseindicatingthestatusofamailboxmessagewhenanerror.title
Response indicating the status of a mailbox message when an error occurs

# components.schemas.93e74a89_Responseindicatingthestatusofamailboxmessagewhenanerror.properties.status.description
Status of the resource `Response indicating the status of a mailbox message when an error occurs`

# components.schemas.93e74a89_MailboxBackup.properties.state.description
Represents the current state of the mailbox backup. This state indicates whether the backup has been successfully recorded or if it is in the process of being restored.ready: Indicates that the backup is ready and has been successfully recorded. restore_in_progress: Indicates that the backup restoration process is in progress.

# components.schemas.93e74a89_ServiceMailboxresponder.properties.id.description
Unique identifier of the resource `Service Mailbox responder`

# components.schemas.93e74a89_ServiceMailboxresponder.properties.name.description
Name of the resource `Service Mailbox responder`

# components.schemas.93e74a89_ServiceMailboxresponder.properties.started_at.description
Timestamp `Service Mailbox responder` has been started

# components.schemas.93e74a89_ServiceMailboxresponder.properties.ended_at.description
Timestamp `Service Mailbox responder` has ended

# components.schemas.93e74a89_ServiceMailboxresponder.properties.reply_from_id.description
Id of the Email that send the auto reply

# components.schemas.93e74a89_ServiceMailboxresponder.properties.dont_reply_to.items.description
List of emails the auto reply won't respond to

# components.schemas.93e74a89_ServiceMailboxresponder.properties.dont_reply_to.description
List of emails the auto reply won't respond to

# components.schemas.93e74a89_Arrayofallaccounts.properties.accounts.items.description
all existing account in the service mail

# components.schemas.93e74a89_Arrayofallaccounts.properties.accounts.description
all existing account in the service mail

# components.schemas.93e74a89_EmailImport.properties.id.description
Unique identifier of the resource `Email Import`

# components.schemas.93e74a89_EmailImport.properties.started_at.description
Timestamp `Email Import` has been started

# components.schemas.93e74a89_WebmailAccess.properties.id.description
Unique identifier of the resource `Webmail Access`

# components.schemas.93e74a89_WebmailAccess.properties.status.description
Specifies the status of the access.healthy: The access is healthy. new: The access is new. spam: The access was sending spam.

# components.schemas.93e74a89_WebmailAccess.properties.created_at.description
Timestamp `Webmail Access` has been created

# components.schemas.93e74a89_SubscribeandUnsubscribeMailingListForm.title
Subscribe and Unsubscribe Mailing List Form

# components.schemas.93e74a89_SubscribeandUnsubscribeMailingListForm.properties.subscription.description
An HTML form for subscribing to the concerned mailing list

# components.schemas.93e74a89_SubscribeandUnsubscribeMailingListForm.properties.unsubscription.description
An HTML form for unsubscribing to the concerned mailing list

# components.schemas.93e74a89_SubscribeandUnsubscribeMailingListForm.properties.unsubscription.example
\n\n\n\n

# components.schemas.93e74a89_DeletedWorkspaceInvitation.properties.deleted.description
Indicates if the invitation was deleted or not

# components.schemas.93e74a89_DeletedWorkspaceInvitation.properties.error.description
Describes the error if the there was an error

# components.schemas.511343ad_Address.properties.id.description
Unique identifier of the resource `Address`

# components.schemas.511343ad_Date.properties.id.description
Unique identifier of the resource `Date`

# components.schemas.511343ad_Date.properties.customer_reserve_seat.description
Access level required to show seat reservation button (admin, admin_reseller, all, hidden)

# components.schemas.511343ad_Date.properties.quota.description
Real quota visible for current user rights depending on zones availabilities

# components.schemas.511343ad_Date.properties.quota_remaining.description
quota remaining depending on zones availabilities

# components.schemas.511343ad_Date.properties.valid_tickets_count.description
Number of tickets scanned or paid or booked

# components.schemas.511343ad_Date.properties.booked_tickets_count.description
Number of tickets booked but not yet paid or scanned

# components.schemas.511343ad_Event.properties.id.description
Unique identifier of the resource `Event`

# components.schemas.511343ad_Event.properties.uuid.description
Universally unique identifier of the resource `Event`

# components.schemas.511343ad_Eventlanguage.properties.id.description
Unique identifier of the resource `Event language`

# components.schemas.511343ad_Eventlanguage.properties.language_id.description
Unique identifier of the `language` that is related to the resource `Event language`

# components.schemas.511343ad_Eventlanguage.properties.description.description
Description of the resource `Event language`

# components.schemas.511343ad_Organizer.properties.id.description
Unique identifier of the resource `Organizer`

# components.schemas.511343ad_Organizer.properties.plan.description
Plan describing organization level with premium subscription, supports, etc

# components.schemas.511343ad_Account.properties.id.description
Unique identifier of the resource `Account`

# components.schemas.511343ad_Account.properties.locale.description
Represents a language identifier and a region identifier

# components.schemas.511343ad_Account.properties.language_id.description
Unique identifier of the `language` that is related to the resource `Account`

# components.schemas.511343ad_Accountaddress.properties.id.description
Unique identifier of the resource `Account address`

# components.schemas.511343ad_Accountaddress.properties.created_at.description
Timestamp `Account address` has been created

# components.schemas.511343ad_Tag.properties.product_count.description
Product count related to the resource `Tag`

# components.schemas.511343ad_User.properties.id.description
Unique identifier of the resource `User`

# components.schemas.511343ad_User.properties.permissions.description
User permissions grouped by group_id with product access rights

# components.schemas.511343ad_.properties.uuid.description
Universally unique identifier of the resource ``

# components.schemas.511343ad_UserGroupPermission.properties.ticketing_products.description
List of ticketing product permissions for this group

# components.schemas.511343ad_UserGroupPermission.description
User permissions grouped by group with product access rights

# components.schemas.511343ad_UserTicketingProductPermission.properties.right.description
User level right (admin, reseller, customer)

# components.schemas.511343ad_UserTicketingProductPermission.description
User permissions for a specific ticketing product (period)

# components.schemas.511343ad_Webinar.properties.id.description
Unique identifier of the resource `Webinar`

# components.schemas.511343ad_Feature.properties.id.description
Unique identifier of the resource `Feature`

# components.schemas.511343ad_ShopSectionLanguage.properties.language_id.description
Unique identifier of the `language` that is related to the resource `ShopSectionLanguage`

# components.schemas.511343ad_ShopSectionLanguage.properties.name.description
Name of the resource `ShopSectionLanguage`

# components.schemas.511343ad_ShopSectionLanguage.description
This model represents a shop section language

# components.schemas.511343ad_ShopLanguage.properties.language_id.description
Unique identifier of the `language` that is related to the resource `ShopLanguage`

# components.schemas.511343ad_ShopLanguage.properties.description.description
Description of the resource `ShopLanguage`

# components.schemas.511343ad_ShopCSP.properties.id.description
Unique identifier of the resource `ShopCSP`

# components.schemas.511343ad_GroupPaymentMode.description
This model represents a group payment modes

# components.schemas.511343ad_GroupPaymentModeLanguage.properties.language_id.description
Unique identifier of the `language` that is related to the resource `Group Payment Mode Language`

# components.schemas.511343ad_GroupPaymentModeLanguage.properties.name.description
Name of the resource `Group Payment Mode Language`

# components.schemas.511343ad_GroupPaymentModeLanguage.description
This model represents a group payment mode language

# components.schemas.511343ad_Genre.properties.id.description
Unique identifier of the resource `Genre`

# components.schemas.511343ad_Genrelanguage.properties.id.description
Unique identifier of the resource `Genre language`

# components.schemas.511343ad_Genrelanguage.properties.language_id.description
Unique identifier of the `language` that is related to the resource `Genre language`

# components.schemas.511343ad_Customportalevent.description
        This model represents the link between an event and a personalized portal (belonging to a particular organizer). 
        The presence of a model means that the event in question is eligible to appear on the organizer's portal.

# components.schemas.511343ad_TariffZone.properties.id.description
Unique identifier of the resource `TariffZone`

# components.schemas.511343ad_TariffZone.properties.quota.description
Real quota available for current user to sale tickets depending on zones availabilities

# components.schemas.511343ad_TariffZoneLanguage.properties.id.description
Unique identifier of the resource `TariffZoneLanguage`

# components.schemas.511343ad_TariffZoneLanguage.properties.name.description
Name of the resource `TariffZoneLanguage`

# components.schemas.511343ad_TariffZoneLanguage.description
This model represents a tariff zone language

# components.schemas.511343ad_TariffCategory.properties.import_id.description
external id for correlation with the tariff

# components.schemas.511343ad_TariffCategory.properties.category_limit.description
Maximum tickets for this tariff-zone association

# components.schemas.511343ad_CategoryLanguage.properties.name.description
Name of the resource `Category Language`

# components.schemas.511343ad_CategoryLanguage.properties.description.description
Description of the resource `Category Language`

# components.schemas.511343ad_CategoryLanguage.description
This model represents a Category Language

# components.schemas.511343ad_Pricecategory.description
This model represents a category of price

# components.schemas.511343ad_TariffFeeLanguage.description
This model represents a tariff fee language

# components.schemas.511343ad_DateCustomProperty.properties.id.description
Unique identifier of this custom property

# components.schemas.511343ad_DateCustomProperty.properties.name_value.description
Combination of name and value (format: name / value)

# components.schemas.511343ad_DateCustomProperty.description
This model represents a DateCustomProperty

# components.schemas.511343ad_MetaProduct.properties.status_id.description
Id of the related status of the metaproduct

# components.schemas.511343ad_MetaProduct.properties.image.description
Image representing the metaproduct displayed in the shop

# components.schemas.511343ad_MetaProduct.properties.count_all_products_sold.description
Sold metaproducts even if order is cancelled

# components.schemas.511343ad_MetaProduct.properties.has_dependencies.description
If the metaproduct is link to other elements with dependency rules

# components.schemas.511343ad_MetaProductLanguage.properties.id.description
Unique identifier of a metaproduct language

# components.schemas.511343ad_MetaProductLanguage.description
This model represents a MetaProductLanguage

# components.schemas.511343ad_ProductAttributeNormalizer.properties.count_products.description
Number of metaproducts linked with this attribute

# components.schemas.511343ad_ProductAttributeNormalizer.description
This model represents a product attribute

# components.schemas.511343ad_ProductAttributeLanguageNormalizer.description
This model represents a ProductAttributeLanguage

# components.schemas.511343ad_ProductAttributeValueNormalizer.description
This model represents a product attribute value

# components.schemas.511343ad_ProductAttributeValueLanguageNormalizer.description
This model represents a product attribute value translation

# components.schemas.511343ad_MetaProductVariantNormalizer.properties.quota.description
Quantity that was available (not the current quantity)

# components.schemas.511343ad_MetaProductVariantPriceNormalizer.description
This model represents a product variant price

# components.schemas.511343ad_Reservation.properties.id.description
Unique identifier of the resource `Reservation`

# components.schemas.511343ad_Reservation.properties.uuid.description
Universally unique identifier of the resource `Reservation`

# components.schemas.511343ad_Customer.properties.language_id.description
Unique identifier of the `language` that is related to the resource `Customer`

# components.schemas.511343ad_PassCategory.properties.pass_category_quota.description
Pass Category quota maximum that can be sold

# components.schemas.511343ad_PassCategory.properties.warning_low_quota.description
Quota after which pass category is considered as low

# components.schemas.511343ad_GiftCode.properties.id.description
Unique identifier of the resource `Gift Code`

# components.schemas.511343ad_GiftCode.description
This model represents a Gift Code (ordered gift)

# components.schemas.511343ad_GiftPrice.properties.id.description
Unique identifier of the resource `Gift Price`

# components.schemas.511343ad_Gift.properties.id.description
Unique identifier of the resource `Gift`

# components.schemas.511343ad_GiftLanguage.properties.id.description
Unique identifier of the resource `GiftLanguage`

# components.schemas.511343ad_GiftLanguage.properties.description.description
Description of the resource `GiftLanguage`

# components.schemas.511343ad_ReservationOperation.properties.id.description
Unique identifier of the resource `ReservationOperation`

# components.schemas.511343ad_ReservationOperationLog.properties.id.description
Unique identifier of the resource `ReservationOperationLog`

# components.schemas.511343ad_SalesOffice.properties.image_hint.description
Image url of this entity without checking presence

# components.schemas.511343ad_PromotionCode.properties.id.description
Unique identifier of the resource `PromotionCode`

# components.schemas.511343ad_Promotion.properties.id.description
Unique identifier of the resource `Promotion`

# components.schemas.511343ad_SurveyBlockLanguage.properties.language_id.description
Unique identifier of the `language` that is related to the resource `SurveyBlockLanguage`

# components.schemas.511343ad_SurveyBlockLanguage.description
This model represents a survey block language

# components.schemas.511343ad_SurveyFieldLanguage.properties.name.description
Name of the resource `SurveyFieldLanguage`

# components.schemas.511343ad_SurveyFieldLanguage.properties.language_id.description
Unique identifier of the `language` that is related to the resource `SurveyFieldLanguage`

# components.schemas.511343ad_SurveyFieldLanguage.description
This model represents a survey field language

# components.schemas.511343ad_TicketSurvey.properties.id.description
Unique identifier of a ticket survey answer

# components.schemas.511343ad_TicketSurvey.properties.value.description
Value filled or values selected under an array if many possible

# components.schemas.511343ad_TicketSurvey.properties.uuid.description
Uuid of a ticket survey answer used for files

# components.schemas.511343ad_TicketSurvey.description
This model represents a ticket survey answer

# components.schemas.511343ad_PassSurvey.properties.id.description
Unique identifier of a pass survey answer

# components.schemas.511343ad_PassSurvey.properties.value.description
Value filled or values selected under an array if many possible

# components.schemas.511343ad_PassSurvey.properties.uuid.description
Uuid of a pass survey answer used for files

# components.schemas.511343ad_PassSurvey.description
This model represents a pass survey answer

# components.schemas.511343ad_ScanLoginResponse.properties.api_key.description
API key used on requests that require authentication

# components.schemas.511343ad_ScanProfilResponse.properties.scan_product.description
number of meta products that the user is allowed to access

# components.schemas.511343ad_ScanProfilResponse.properties.has_periods.description
Does the connected user has periods access ?

# components.schemas.511343ad_ScanProfilResponse.properties.preferences.description
user preferences like default scan mode, enabled scan modes, if photo is on the pass or if tickets are automatically add to pass, available only for profil_scan type

# components.schemas.511343ad_ScanProfilResponse.description
This model represents a scan profile response

# components.schemas.511343ad_ScanStatsResponse.properties.myself.description
total number of tickets scanned with the scanner (myself = your hardware id)

# components.schemas.511343ad_ScanStatsResponse.description
This model represents a scan stats response

# components.schemas.511343ad_ScanTicketsResponse_aeaff160.description
This model represents a scan tickets response

# components.schemas.511343ad_ScanTicketsResponse.properties.status.description
Status of the resource `Scan Tickets Response`

# components.schemas.511343ad_ScanTicketsResponse.description
This model represents a scan tickets response

# components.schemas.511343ad_ScanPass.description
Minimal pass information returned by scan tickets routes

# components.schemas.511343ad_ScanAddTicketsToPassResponse.properties.barcode.description
the membership card (code) on which you want to add tickets

# components.schemas.511343ad_ScanAddTicketsToPassResponse.properties.date_id.description
deprecated - date on which you added tickets to the pass

# components.schemas.511343ad_ScanAddTicketsToPassResponse.properties.date_ids.description
dates on which you added tickets to the pass

# components.schemas.511343ad_ScanAddTicketsToPassResponse.description
This model represents the response of AddTicketsToPass() method

# components.schemas.97034793_EquipmentBase.properties.id.description
Unique identifier of the resource `EquipmentBase`

# components.schemas.97034793_EquipmentBase.properties.description.description
Description of the resource `EquipmentBase`

# components.schemas.97034793_HardwareModel.properties.id.description
Unique identifier of the resource `HardwareModel`

# components.schemas.97034793_EquipmentTag.properties.id.description
Unique identifier of the resource `EquipmentTag`

# components.schemas.97034793_EquipmentServer.properties.id.description
Unique identifier of the resource `EquipmentServer`

# components.schemas.97034793_EquipmentServer.properties.description.description
Description of the resource `EquipmentServer`

# components.schemas.97034793_EquipmentServer.properties.rack_name.description
Name of installed rack if is in production

# components.schemas.97034793_EquipmentServer.properties.rack_id.description
Id of installed rack if is in production

# components.schemas.97034793_PhysicalServer.properties.id.description
Unique identifier of the resource `PhysicalServer`

# components.schemas.97034793_LogicalServer.properties.description.description
Description of the resource `LogicalServer`

# components.schemas.97034793_LogicalServer.properties.created_at.description
Timestamp `LogicalServer` has been created

# components.schemas.97034793_LogicalServer.description
This model represents a logical server, could be a main server or a VM.

# components.schemas.97034793_EquipmentRouter.properties.id.description
Unique identifier of the resource `EquipmentRouter`

# components.schemas.97034793_EquipmentRouter.properties.description.description
Description of the resource `EquipmentRouter`

# components.schemas.97034793_EquipmentRouter.properties.rack_name.description
Name of installed rack if is in production

# components.schemas.97034793_EquipmentRouter.properties.rack_id.description
Id of installed rack if is in production

# components.schemas.97034793_EquipmentRack.properties.id.description
Unique identifier of the resource `EquipmentRack`

# components.schemas.97034793_EquipmentRack.properties.description.description
Description of the resource `EquipmentRack`

# components.schemas.97034793_Reservation.properties.id.description
Unique identifier of the resource `Reservation`

# components.schemas.97034793_Order.properties.id.description
Unique identifier of the resource `Order`

# components.schemas.6a791d9b_api-domain_domain.properties.resale_status.description
The status of the domain regarding resale

# components.schemas.6a791d9b_api-domain_contact.properties.is_validated.description
Whether the contact email has been verified

# components.schemas.6a791d9b_api-domain_contact.properties.validated_at.description
Timestamp when the contact was validated

# components.schemas.6a791d9b_api-domain_contact.properties.associated_domains.description
Domains associated with this contact (capped preview, see associated_domains_count for the total)

# components.schemas.6a791d9b_api-domain_contact.properties.associated_domains_count.description
Total number of domains associated with this contact

# components.schemas.6a791d9b_api-domain_contact_modification.properties.is_validated.description
Whether the modification has been validated

# components.schemas.6a791d9b_api-domain_contact_modification.properties.associated_domains.description
Domains associated with this contact (capped preview, see associated_domains_count for the total)

# components.schemas.6a791d9b_api-domain_contact_modification.properties.associated_domains_count.description
Total number of domains associated with this contact

# components.schemas.6a791d9b_api-domain_contact_handle.properties.is_verified.description
Whether the handle has been verified against the registry

# components.schemas.6a791d9b_api-domain_domain_dnssec_record.properties.ksk.properties.algorithm.description
The algorithm used to generate the public key

# components.schemas.6a791d9b_api-domain_domain_dnssec_data.properties.protocol.description
The DNSSEC protocol used to generate the public key

# components.schemas.6a791d9b_api-domain_domain_dnssec_data.properties.algorithm.description
The algorithm used to generate the public key

# components.schemas.6a791d9b_api-domain_domain_dnssec_data.properties.digest_type.description
The type of digest used to generate the public key

# components.schemas.6a791d9b_api-domain_domain_email_sent.properties.recipients.items.description
List of email addresses that received the email

# components.schemas.6a791d9b_api-domain_domain_email_sent.properties.recipients.description
List of email addresses that received the email

# components.schemas.6a791d9b_api-domain_contact_verification.properties.validator_id.description
Staff user who validated the verification

# components.schemas.6a791d9b_api-domain_document.properties.id.description
Unique identifier of the resource `Domain Document`

# components.schemas.6a791d9b_File.properties.id.description
Unique identifier of the resource `File`

# components.schemas.6a791d9b_api-domain_contact_update_result.properties.is_validation_required.description
Whether the update requires validation via email

# components.schemas.6a791d9b_api-domain_contact_update_result.properties.validation_sent_to.description
Email address where validation link was sent (only if is_validation_required is true)

# components.schemas.6a791d9b_api-domain_domain_termination_result.properties.is_validation_required.description
Whether the termination requires validation via email

# components.schemas.6a791d9b_api-domain_domain_termination_result.properties.validation_sent_to.description
Email address where validation link was sent (only if is_validation_required is true)

# components.schemas.6a791d9b_api-domain_domain_whois.properties.state.description
Returns the status of the domain, whether it can be registered on our services or not

# components.schemas.6a791d9b_api-domain_domain_transfer_out_ipstag_validation.properties.is_validated.description
Whether the IPS tag change has been processed

# components.schemas.6a791d9b_api-domain_domain_trade_details.properties.validator.description
Who needs to validate this trade (old or new owner)

# components.schemas.6a791d9b_api-domain_domain_trade.properties.has_old_owner_validated.description
Whether old owner has validated the trade

# components.schemas.6a791d9b_api-domain_domain_trade.properties.has_new_owner_validated.description
Whether new owner has validated the trade

# components.schemas.6a791d9b_api-domain_domain_maintenance_tld.properties.maintenance_end.description
Maintenance end timestamp. If not specified, maintenance has no defined end

# components.schemas.6a791d9b_api-domain_domain_maintenance_tld.properties.comment.example
Scheduled maintenance for registry upgrade

# components.schemas.6a791d9b_api-domain_domain_maintenance_tld.properties.for_sale.description
Whether the TLD is available for sale during maintenance

# components.schemas.6a791d9b_api_domain_tld.properties.registration_delay.properties.min.description
Minimal required time for registration in minutes

# components.schemas.6a791d9b_api_domain_tld.properties.registration_delay.properties.max.description
Maximum required time for registration in minutes

# components.schemas.6a791d9b_api_domain_tld.properties.trade_delay.properties.min.description
Minimal required time for trade in minutes

# components.schemas.6a791d9b_api_domain_tld.properties.trade_delay.properties.max.description
Maximum required time for trade in minutes

# components.schemas.6a791d9b_api_domain_tld.properties.trade_delay.description
Required time range for trade (not set if trade not allowed)

# components.schemas.6a791d9b_api_domain_tld.properties.periods.properties.renew_grace.description
Time after domain expiry during which it can still be renewed without extra fees or loss of ownership. (days)

# components.schemas.6a791d9b_api_domain_tld.properties.periods.properties.redemption.description
Time after grace period during which the domain can be redeemed with additional fees. (days)

# components.schemas.6a791d9b_api_domain_tld.properties.periods.properties.deletion.description
Period after redemption period during which the domain is purged from registry and becomes available for re-registration. (days)

# components.schemas.6a791d9b_api_domain_tld.properties.renewal_periods.items.description
All the available renewal periods. (years)

# components.schemas.6a791d9b_api_domain_tld.properties.renewal_periods.description
All the available renewal periods. (years)

# components.schemas.6a791d9b_api_domain_tld.properties.registration_periods.items.description
All the available registration periods. (years)

# components.schemas.6a791d9b_api_domain_tld.properties.registration_periods.description
All the available registration periods. (years)

# components.schemas.6a791d9b_api_domain_tld.properties.outgoing_transfer_need.properties.auth_code.description
Outgoing transfer method requires Auth Code

# components.schemas.6a791d9b_api_domain_tld.properties.outgoing_transfer_need.properties.auth_code_length.description
Length of the authorization code needed for domain transfers.

# components.schemas.6a791d9b_api_domain_tld.properties.outgoing_transfer_need.properties.ips_tag.description
Outgoing transfer method requires IPs Tag

# components.schemas.6a791d9b_api-domain_tld_fields.properties.registration.description
The required additional fields on registration

# components.schemas.6a791d9b_api-domain_tld_fields.properties.transfer.description
The required additional fields on transfer

# components.schemas.6a791d9b_api-domain_contact_field.properties.restricted_fields.description
All the contact fields that has a guideline

# components.schemas.6a791d9b_api-domain_tld_field.properties.required_conditions.description
Field required condition (if set determines the requirability of the field, if not set refer to the 'required' boolean)

# components.schemas.6a791d9b_api-domain_tld_field_condition.properties.logic.description
The logical operator linking the previous and current condition

# components.schemas.6a791d9b_Registryconsoleconfig.properties.actions.description
Available operations as {action, group} pairs

# components.schemas.6a791d9b_api-domain_registry_console_item.properties.environments.items.description
The environments the registry can target

# components.schemas.6a791d9b_api-domain_registry_console_item.properties.environments.description
The environments the registry can target

# components.schemas.2f8071fd_api_dns_dns_record.properties.dyndns_id.description
If any, the dyndns user identifier related to the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.priority.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.priority.description
Only available with MX and SRV dns record, the priority attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.port.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.port.description
Only available with SRV dns record, the port attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.weight.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.weight.description
Only available with SRV dns record, the weight attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.protocol.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.protocol.description
Only available with SRV and DNSKEY dns record, the protocol attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.flags.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.flags.description
Only available with CAA and DNSKEY dns record, the flags attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.tag.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.tag.description
Only available with CAA dns record, the tag attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.usage.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.usage.description
Only available with TLSA or SMIMEA dns record, the usage attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.selector.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.selector.description
Only available with TLSA or SMIMEA dns record, the selector attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.matching_type.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.matching_type.description
Only available with TLSA, SSHFP or SMIMEA dns record, the matching type attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.algorithm.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.algorithm.description
Only available with SSHFP, DS and DNSKEY dns record, the algorithm attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.key_tag.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.key_tag.description
Only available with DS dns record, the key tag attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.digest_type.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.digest_type.description
Only available with DS dns record, the digest type attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.digest.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.digest.description
Only available with DS dns record, the digest type attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.mname.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.mname.description
Only available with SOA dns record, the mname attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.rname.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.rname.description
Only available with SOA dns record, the rname attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.serial.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.serial.description
Only available with SOA dns record, the serial attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.refresh.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.refresh.description
Only available with SOA dns record, the refresh attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.retry.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.retry.description
Only available with SOA dns record, the retry attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.expire.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.expire.description
Only available with SOA dns record, the expire attribute of the dns record

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.minimum_ttl.properties.label.description
The human readable value of the attribute

# components.schemas.2f8071fd_api_dns_dns_record_description.properties.minimum_ttl.description
Only available with SOA dns record, the minimum ttl attribute of the dns record

# components.schemas.2f8071fd_api_dns_dnssec_export.properties.dnssec_data.description
The exported DNSSEC data as a zip file encoded in base64

# components.schemas.087adaad_AccountInvitation.properties.id.description
Unique identifier of the resource `AccountInvitation`

# components.schemas.087adaad_AccountInvitation.properties.status.description
Status of the resource `AccountInvitation`

# components.schemas.087adaad_AccountInvitation.properties.language_id.description
Unique identifier of the `language` that is related to the resource `AccountInvitation`

# components.schemas.087adaad_AccountInvitation.properties.locale.description
Represents a language identifier and a region identifier

# components.schemas.087adaad_AccountInvitation.properties.account_id.description
Unique identifier of the `account` that is related to the resource `AccountInvitation`

# components.schemas.087adaad_AccountInvitation.properties.created_at.description
Timestamp `AccountInvitation` has been created

# components.schemas.087adaad_AccountInvitation.properties.updated_at.description
Timestamp `AccountInvitation` has been updated

# components.schemas.087adaad_Team.properties.id.description
Unique identifier of the resource `Team`

# components.schemas.087adaad_Team.properties.color_id.description
Unique identifier of the `color` of the resource `Team`

# components.schemas.087adaad_Team.properties.user_count.description
User count related to the resource `Team`

# components.schemas.087adaad_Partnership.properties.id.description
Unique identifier of the resource `Partnership`

# components.schemas.087adaad_Partnership.properties.color_id.description
Unique identifier of the `color` of the resource `Partnership`

# components.schemas.087adaad_Partnership.properties.owned_by_id.description
Unique identifier of the `user` that owned the resource `Partnership`

# components.schemas.087adaad_Partnership.properties.created_by_id.description
Unique identifier of the `user` that created the resource `Partnership`

# components.schemas.087adaad_Partnership.properties.created_at.description
Timestamp `Partnership` has been created

# components.schemas.087adaad_Partnership.properties.updated_at.description
Timestamp `Partnership` has been updated

# components.schemas.087adaad_Partnership.properties.user_count.description
User count related to the resource `Partnership`

# components.schemas.087adaad_Partnership.properties.product_count.description
Product count related to the resource `Partnership`

# components.schemas.087adaad_Partnership.properties.product_by_service_count.description
Product by service count related to the resource `Partnership`

# components.schemas.087adaad_Partnership.properties.has_customer_payment_method.description
True if the payment method chosen is customer

# components.schemas.087adaad_User.properties.id.description
Unique identifier of the resource `User`

# components.schemas.087adaad_User.properties.is_sso.description
returns true if the user is provided by an external IDP

# components.schemas.087adaad_User.properties.avatar.description
null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar

# components.schemas.087adaad_Partner.properties.id.description
Unique identifier of the resource `Partner`

# components.schemas.087adaad_RoleRight.properties.service_id.description
Unique identifier of the `service` that is related to the resource `RoleRight`

# components.schemas.087adaad_RoleRight.properties.product_id.description
Unique identifier of the `product` that is related to the resource `RoleRight`

# components.schemas.087adaad_Account.properties.id.description
Unique identifier of the resource `Account`

# components.schemas.087adaad_Account.properties.locale.description
Represents a language identifier and a region identifier

# components.schemas.087adaad_Account.properties.language_id.description
Unique identifier of the `language` that is related to the resource `Account`

# components.schemas.087adaad_Account.properties.ksuite_id.description
Unique identifier of the `ksuite` that is related to the resource `Account`

# components.schemas.087adaad_Accountaddress.properties.id.description
Unique identifier of the resource `Account address`

# components.schemas.087adaad_Accountaddress.properties.created_at.description
Timestamp `Account address` has been created

# components.schemas.087adaad_Country.properties.id.description
Unique identifier of the resource `Country`

# components.schemas.087adaad_Tag.properties.product_count.description
Product count related to the resource `Tag`

# components.schemas.087adaad_Team_db41ff58.properties.id.description
Unique identifier of the resource `Team`

# components.schemas.087adaad_Team_db41ff58.properties.color_id.description
Unique identifier of the `color` of the resource `Team`

# components.schemas.087adaad_Team_db41ff58.properties.owned_by_id.description
Unique identifier of the `user` that owned the resource `Team`

# components.schemas.087adaad_Team_db41ff58.properties.created_by_id.description
Unique identifier of the `user` that created the resource `Team`

# components.schemas.087adaad_Team_db41ff58.properties.user_count.description
User count related to the resource `Team`

# components.schemas.087adaad_Team_db41ff58.properties.product_count.description
Product count related to the resource `Team`

# components.schemas.087adaad_Team_db41ff58.properties.product_by_service_count.description
Product by service count related to the resource `Team`

# components.schemas.087adaad_Servicepermissions.properties.service_id.description
Unique identifier of the `service` that is related to the resource `Service permissions`

# components.schemas.087adaad_ProductTeamPermissions.properties.service_id.description
Unique identifier of the `service` that is related to the resource `Product Team Permissions`

# components.schemas.087adaad_ProductTeamPermissions.properties.product_id.description
Unique identifier of the `product` that is related to the resource `Product Team Permissions`

# components.schemas.087adaad_TeamUser.properties.id.description
Unique identifier of the resource `Team User`

# components.schemas.087adaad_TeamUser.properties.is_sso.description
returns true if the user is provided by an external IDP

# components.schemas.087adaad_Applicationbexversionwhitelist.properties.id.description
Unique identifier of the resource `Application bex version whitelist`

# components.schemas.087adaad_PartnerInvitation.properties.id.description
Unique identifier of the resource `PartnerInvitation`

# components.schemas.087adaad_PartnerInvitation.properties.status.description
Status of the resource `PartnerInvitation`

# components.schemas.087adaad_PartnerInvitation.properties.account_id.description
Unique identifier of the `account` that is related to the resource `PartnerInvitation`

# components.schemas.087adaad_PartnerInvitation.properties.created_at.description
Timestamp `PartnerInvitation` has been created

# components.schemas.087adaad_PartnerInvitation.properties.updated_at.description
Timestamp `PartnerInvitation` has been updated

# components.schemas.087adaad_PartnerInvitation.properties.deleted_at.description
Timestamp `PartnerInvitation` has been deleted

# components.schemas.087adaad_PartnerInvitationData.properties.full_access.description
Describes the type of access the partner has on its client

# components.schemas.087adaad_Device.properties.id.description
Unique identifier of the resource `Device`

# components.schemas.087adaad_Memo.properties.user_id.description
The ID of the user the memo is assigned to.

# components.schemas.087adaad_Memo.properties.account_id.description
The ID of the account the memo belongs to.

# components.schemas.087adaad_Memo.properties.request_context_id.description
The ID of the request context if applicable.

# components.schemas.087adaad_Memo.properties.is_sticky.description
Whether the memo is marked as sticky/pinned.

# components.schemas.087adaad_Memo.properties.is_mega.description
Whether the memo is marked as mega/important (comite only).

# components.schemas.087adaad_Event.properties.id.description
Unique identifier of the resource `Event`

# components.schemas.087adaad_EventTag.properties.id.description
Unique identifier of the resource `Event Tag`

# components.schemas.087adaad_Userapplicationpassword.properties.id.description
Unique identifier of the resource `User application password`

# components.schemas.087adaad_Userapplicationpassword.properties.name.description
Name of the resource `User application password`

# components.schemas.087adaad_partialUserapplicationpassword.properties.id.description
Unique identifier of the resource `(partial) User application password`

# components.schemas.087adaad_partialUserapplicationpassword.properties.name.description
Name of the resource `(partial) User application password`

# components.schemas.087adaad_Service.properties.id.description
Unique identifier of the resource `Service`

# components.schemas.087adaad_Team_2a133770.properties.id.description
Unique identifier of the resource `Team`

# components.schemas.087adaad_Team_2a133770.properties.color_id.description
Unique identifier of the `color` of the resource `Team`

# components.schemas.087adaad_Team_2a133770.properties.owned_by_id.description
Unique identifier of the `user` that owned the resource `Team`

# components.schemas.087adaad_Team_2a133770.properties.created_by_id.description
Unique identifier of the `user` that created the resource `Team`

# components.schemas.087adaad_Team_2a133770.properties.user_count.description
User count related to the resource `Team`

# components.schemas.087adaad_Team_2a133770.properties.product_count.description
Product count related to the resource `Team`

# components.schemas.087adaad_Team_2a133770.properties.product_by_service_count.description
Product by service count related to the resource `Team`

# components.schemas.087adaad_Actiontype.properties.id.description
Unique identifier of the resource `Action type`

# components.schemas.087adaad_Actiontype.properties.description.description
Description of the resource `Action type`

# components.schemas.087adaad_Application.properties.id.description
Unique identifier of the resource `Application`

# components.schemas.087adaad_Application.properties.next_version_rate.description
The percentage of users who will receive the production-next version in advance

# components.schemas.087adaad_Application.properties.nb_users.description
number of users, only for kStore application

# components.schemas.087adaad_AsyncTask.properties.uuid.description
Universally unique identifier of the resource `Async Task`

# components.schemas.087adaad_AsyncTask.properties.executed_at.description
Timestamp `Async Task` has been executed

# components.schemas.087adaad_Product.properties.id.description
Unique identifier of the resource `Product`

# components.schemas.087adaad_Product.properties.account_id.description
Unique identifier of the `account` that is related to the resource `Product`

# components.schemas.087adaad_Product.properties.service_id.description
Unique identifier of the `service` that is related to the resource `Product`

# components.schemas.087adaad_Product.properties.has_maintenance.description
Does the resource `Product` have a maintenance mode enabled?

# components.schemas.087adaad_Product.properties.has_operation_in_progress.description
Does the resource `Product` have an operation in progress ?

# components.schemas.087adaad_Product.properties.unique_id.description
Unique identifier of the resource `Product`

# components.schemas.087adaad_Product.properties.is_free.description
Does the resource `Product` have a free price status?

# components.schemas.087adaad_Product.properties.is_zero_price.description
Does the resource `Product` have a zero price status?

# components.schemas.087adaad_Product.properties.is_trial.description
Does the resource `Product` have a trial status?

# components.schemas.087adaad_PartnershipProductAccess.properties.product_id.description
Unique identifier of the `product` that is related to the resource `Partnership Product Access`

# components.schemas.087adaad_PartnershipProductAccess.properties.service_id.description
Unique identifier of the `service` that is related to the resource `Partnership Product Access`

# components.schemas.087adaad_PartnershipProductAccessUser.properties.id.description
Unique identifier of the resource `Partnership Product Access User`

# components.schemas.087adaad_B2BProductNormalizer.properties.id.description
Unique identifier of the resource `B2BProductNormalizer`

# components.schemas.087adaad_B2BProductNormalizer.properties.service_id.description
Unique identifier of the `service` that is related to the resource `B2BProductNormalizer`

# components.schemas.087adaad_B2BProductNormalizer.properties.account_id.description
Unique identifier of the `account` that is related to the resource `B2BProductNormalizer`

# components.schemas.087adaad_B2BProductNormalizer.properties.customer_name.description
Customer name of the resource `B2BProductNormalizer`

# components.schemas.087adaad_B2BProductNormalizer.properties.is_trial.description
Does the resource `B2BProductNormalizer` have a trial status?

# components.schemas.087adaad_B2BProductNormalizer.properties.is_free.description
Does the resource `B2BProductNormalizer` have a free price status?

# components.schemas.087adaad_B2BProductNormalizer.properties.is_locked.description
Is the resource `B2BProductNormalizer` locked?

# components.schemas.087adaad_B2BProductNormalizer.properties.has_maintenance.description
Does the resource `B2BProductNormalizer` have a maintenance mode enabled?

# components.schemas.087adaad_B2BProductNormalizer.properties.has_operation_in_progress.description
Does the resource `B2BProductNormalizer` have an operation in progress ?

# components.schemas.087adaad_Language.properties.id.description
Unique identifier of the resource `Language`

# components.schemas.087adaad_Language.properties.locale.description
Represents a language identifier and a region identifier

# components.schemas.087adaad_MyKSuite.properties.id.description
Unique identifier of the resource `MyKSuite`

# components.schemas.087adaad_MyKSuite.properties.is_free.description
Does the resource `MyKSuite` have a free price status?

# components.schemas.087adaad_Timezone.properties.id.description
Unique identifier of the resource `Timezone`

# components.schemas.087adaad_Userorpendinguser.properties.avatar.description
null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar

# components.schemas.087adaad_Userorpendinguser.properties.language_id.description
Unique identifier of the `language` that is related to the resource `User or pending user`

# components.schemas.087adaad_Userorpendinguser.properties.last_login_at.description
Timestamp `User or pending user` has been logged

# components.schemas.087adaad_Event_de1ac26c.properties.id.description
Unique identifier of the resource `Event`

# components.schemas.087adaad_EventDescription.properties.description.description
Description of the resource `Event Description`

# components.schemas.087adaad_EventDescription.properties.description.example
This maintenance is intended to increase the capacity of our network infrastructure in order to accompany the growth of our activities.

# components.schemas.087adaad_EventTranslation.properties.body.example
This maintenance is intended to increase the capacity of our network infrastructure in order to accompany the growth of our activities.

# components.schemas.087adaad_EventComment.properties.started_at.description
Timestamp `Event Comment` has been started

# components.schemas.087adaad_UserProfile.properties.id.description
Unique identifier of the resource `User Profile`

# components.schemas.087adaad_UserProfile.properties.is_sso.description
returns true if the user is provided by an external IDP

# components.schemas.087adaad_UserProfile.properties.avatar.description
null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar

# components.schemas.087adaad_UserProfile.properties.preferences.properties.security.properties.last_login_at.description
Timestamp `User Profile` has been logged

# components.schemas.087adaad_Userauthdevice.properties.id.description
Unique identifier of the resource `User auth device`

# components.schemas.087adaad_Userauthdevice.properties.created_at.description
Timestamp `User auth device` has been created

# components.schemas.087adaad_Userauthdevice.properties.updated_at.description
Timestamp `User auth device` has been updated

# components.schemas.087adaad_Userauthdevice.properties.deleted_at.description
Timestamp `User auth device` has been deleted

# components.schemas.087adaad_Userphone.properties.id.description
Unique identifier of the resource `User phone`

# components.schemas.087adaad_Useremail.properties.id.description
Unique identifier of the resource `User email`

# components.schemas.087adaad_Useremail_f4611cfe.properties.id.description
Unique identifier of the resource `User email`

# components.schemas.087adaad_UserProfile_da748377.properties.language_id.description
Unique identifier of the `language` that is related to the resource `User Profile`

# components.schemas.087adaad_UserProfile_da748377.properties.locale.description
Represents a language identifier and a region identifier

# components.schemas.087adaad_UserProfile_da748377.properties.id.description
Unique identifier of the resource `User Profile`

# components.schemas.087adaad_UserProfile_da748377.properties.validated_at.description
Timestamp `User Profile` has been validated

# components.schemas.087adaad_UserProfile_da748377.properties.last_login_at.description
Timestamp `User Profile` has been logged

# components.schemas.087adaad_Country_e76d7464.properties.id.description
Unique identifier of the resource `Country`

# components.schemas.087adaad_Usersupportticket.properties.id.description
Unique identifier of the resource `User support ticket`

# components.schemas.087adaad_Usersupportticket.properties.status.description
Status of the resource `User support ticket`

# components.schemas.087adaad_Usernewsletterlist.properties.service_id.description
Unique identifier of the `service` that is related to the resource `User newsletter list`

# components.schemas.087adaad_Passkey.properties.uuid.description
Universally unique identifier of the resource `Passkey`

# components.schemas.4cee7ea0_Llmproduct.properties.product_id.description
Unique identifier of the `product` that is related to the resource `Llm product`

# components.schemas.4cee7ea0_AiModel.properties.id.description
Unique identifier of the resource `Ai Model`

# components.schemas.4cee7ea0_AiModel.properties.endpoints.items.description
List of endpoints/routes where the model is available.<br>The values returned are the part of the URLs of this doc after `https://developer.infomaniak.com/docs/api/`, *i.e.*: `{HTTP method lowercase}/{API URI after https://api.infomaniak.com/`}

# components.schemas.4cee7ea0_AiModel.properties.endpoints.description
List of endpoints/routes where the model is available.<br>The values returned are the part of the URLs of this doc after `https://developer.infomaniak.com/docs/api/`, *i.e.*: `{HTTP method lowercase}/{API URI after https://api.infomaniak.com/`}

# components.schemas.4cee7ea0_AIPriceunit.properties.type.description
The type of pricing, either `tokens` (ie token-count) or `minute` (ie time-processing)

# components.schemas.4cee7ea0_AIPriceunit.properties.amount.description
Depends on the billing type of the model:
• `tokens` aka *token-count*: **N** such that the price is CHF or EUR per **N** tokens
• `minute` aka *time-processing*: **N** such that the price is CHF or EUR per **N** minute (of processing)

# components.schemas.4cee7ea0_AiModel-meta.properties.is_beta.description
`true` if the model is in **beta** and is subject to changes, see the [General Terms and Conditions](https://www.infomaniak.com/gtl/rgpd.documents)

# components.schemas.4cee7ea0_AiModel-meta.properties.is_coder.description
`true` if the model is code-oriented, typically agentic models such as [Qwen/Qwen3-Coder-480B-A35B-Instruct](https://huggingface.co/Qwen/Qwen3-Coder-480B-A35B-Instruct) or [moonshotai/Kimi-K2.5](https://huggingface.co/moonshotai/Kimi-K2.5). These models have their dedicated sales page on top of the default one.

# components.schemas.4cee7ea0_AiModel-meta.description
Various meta information about the model

# components.schemas.4cee7ea0_AIModellanguage.properties.name.description
Name of the resource `AI Model language`

# components.schemas.4cee7ea0_Base64imageresponse.properties.created.description
The Unix timestamp (in seconds) of when the response was created.

# components.schemas.4cee7ea0_Base64image.properties.revised_prompt.description
We are not currently revising the input prompt

# components.schemas.4cee7ea0_OpenAi-V1-Models.properties.object.description
The object type, which is always `list`.

# components.schemas.4cee7ea0_OpenAi-V1-Models.description
OpenAI model collection format of /v1/models

# components.schemas.4cee7ea0_OpenAi-V1-Models-Model.properties.id.description
The model identifier, which can be referenced in the API endpoints.

# components.schemas.4cee7ea0_OpenAi-V1-Models-Model.properties.object.description
The object type, which is always `model`.

# components.schemas.4cee7ea0_OpenAi-V1-Models-Model.properties.created.description
The Unix timestamp (in seconds) when the model was created.

# components.schemas.4cee7ea0_OpenAi-V1-Models-Model.description
Describes a model that can be used with the API.

# components.schemas.4cee7ea0_LlmResponseOpenAI.properties.object.description
The object `chat.completion` if not stream mode else `chat.completion.chunk`

# components.schemas.4cee7ea0_LlmResponseOpenAI.properties.system_fingerprint.description
This fingerprint represents the backend configuration that the model runs with.

# components.schemas.4cee7ea0_LlmResponseOpenAI.properties.created.description
The Unix timestamp (in seconds) of when the response was created.

# components.schemas.4cee7ea0_LlmResponseOpenAI.properties.choices.description
A list of completion choices. Can be more than one if n is greater than 1.

# components.schemas.4cee7ea0_LlmResponseOpenAI.description
Represents a completion response returned by model, based on the provided input.

# components.schemas.4cee7ea0_Choice.properties.finish_reason.description
The reason the model stopped generating tokens

# components.schemas.4cee7ea0_Logprobability_d8263ce6.properties.content.description
A list of message content tokens with log probability information.

# components.schemas.4cee7ea0_Logprobability_d8263ce6.description
Log probability information for the choice.

# components.schemas.4cee7ea0_Logprobability.properties.bytes.items.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

# components.schemas.4cee7ea0_Logprobability.properties.bytes.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

# components.schemas.4cee7ea0_Logprobability.properties.top_logprobs.description
List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.

# components.schemas.4cee7ea0_Logprobability.description
Log probability information for the choice.

# components.schemas.4cee7ea0_Mostlikelytoken.properties.bytes.items.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

# components.schemas.4cee7ea0_Mostlikelytoken.properties.bytes.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

# components.schemas.4cee7ea0_Mostlikelytoken.description
most likely token and their log probability

# components.schemas.4cee7ea0_Usage.properties.output_tokens.description
Number of tokens in the generated completion.

# components.schemas.4cee7ea0_Usage.properties.completion_tokens.description
Number of tokens in the generated completion.

# components.schemas.4cee7ea0_Usage.properties.total_tokens.description
Total number of tokens used in the request (input+output).

# components.schemas.4cee7ea0_Usage.properties.completion_tokens_details.description
Detailed breakdown of completion tokens.

# components.schemas.4cee7ea0_LlmSpeech-To-TextasyncmodeResponse.properties.batch_id.description
The id of the batch dispatched handling the transcription.

# components.schemas.4cee7ea0_LlmSpeech-To-TextasyncmodeResponse.description
Represents a response returned by a model in async mode.

# components.schemas.4cee7ea0_EmbeddingResponse_213f68bb.properties.object.description
The object type, which is always "list".

# components.schemas.4cee7ea0_Embeddingobject.properties.index.description
The index of the embedding in the list of embeddings.

# components.schemas.4cee7ea0_Embeddingobject.properties.object.description
The object type, which is always "embedding".

# components.schemas.4cee7ea0_Embeddingobject.properties.embedding.items.description
The embedding vector, which is a list of floats.

# components.schemas.4cee7ea0_Embeddingobject.properties.embedding.description
The embedding vector, which is a list of floats.

# components.schemas.4cee7ea0_EmbeddingResponseBase64.properties.object.description
The object type, which is always "list".

# components.schemas.4cee7ea0_Embeddingobjectbase64.properties.index.description
The index of the embedding in the list of embeddings.

# components.schemas.4cee7ea0_Embeddingobjectbase64.properties.object.description
The object type, which is always "embedding".

# components.schemas.4cee7ea0_Embeddingobjectbase64.properties.embedding.description
The embedding vector, which is a list of floats.

# components.schemas.4cee7ea0_LlmSpeech-To-TextsyncmodeResponse.description
Represents a transcription response returned by a model.

# components.schemas.4cee7ea0_LlmSpeech-To-TextsyncmodeverboseJSONResponse.title
Llm Speech-To-Text sync mode verbose JSON Response

# components.schemas.4cee7ea0_LlmSpeech-To-TextsyncmodeverboseJSONResponse.properties.segments.description
Segments of the transcribed text and their corresponding details.

# components.schemas.4cee7ea0_LlmSpeech-To-TextsyncmodeverboseJSONResponse.properties.words.description
Extracted words and their corresponding timestamps.

# components.schemas.4cee7ea0_LlmSpeech-To-TextsyncmodeverboseJSONResponse.description
Represents a verbose JSON transcription response returned by a model.

# components.schemas.4cee7ea0_Speech-to-TextSegment.properties.tokens.items.description
Array of token IDs for the text content.

# components.schemas.4cee7ea0_Speech-to-TextSegment.properties.tokens.description
Array of token IDs for the text content.

# components.schemas.4cee7ea0_Speech-to-TextSegment.properties.temperature.description
Temperature parameter used for generating the segment.

# components.schemas.4cee7ea0_Speech-to-TextSegment.properties.avg_logprob.description
Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.

# components.schemas.4cee7ea0_Speech-to-TextSegment.properties.compression_ratio.description
Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.

# components.schemas.4cee7ea0_Speech-to-TextSegment.properties.no_speech_prob.description
Probability of no speech in the segment. If the value is higher than 1.0 and the avg_logprob is below -1, consider this segment silent.

# components.schemas.4cee7ea0_Speech-to-TextWordtimestamp.description
World level timestamp for speech-to-text response.

# components.schemas.4cee7ea0_BatchResponse.properties.total_jobs.description
The total number of jobs that belong to the batch.

# components.schemas.4cee7ea0_BatchResponse.properties.pending_jobs.description
The total number of jobs that are still pending.

# components.schemas.4cee7ea0_BatchResponse.properties.processed_jobs.description
The total number of jobs that have been processed by the batch thus far.

# components.schemas.4cee7ea0_BatchResponse.properties.failed_jobs.description
The total number of jobs that have failed.

# components.schemas.4cee7ea0_BatchResponse.properties.progress.description
The percentage of jobs that have been processed (between 0-100).

# components.schemas.4cee7ea0_BatchResponse.properties.created_at.description
The date indicating when the batch was created.

# components.schemas.4cee7ea0_BatchResponse.properties.cancelled_at.description
The date indicating when the batch was cancelled.

# components.schemas.4cee7ea0_BatchResponse.properties.finished_at.description
The date indicating when the batch was finished.

# components.schemas.4cee7ea0_BatchResponse.description
Represents a response returned for a batch.

# components.schemas.4cee7ea0_LlmConfig.properties.id.description
Unique identifier of the resource `Llm Config`

# components.schemas.4cee7ea0_LlmConfig.properties.account_id.description
Unique identifier of the `account` that is related to the resource `Llm Config`

# components.schemas.4cee7ea0_LlmConfig.properties.service_id.description
Unique identifier of the `service` that is related to the resource `Llm Config`

# components.schemas.4cee7ea0_LlmConfig.properties.customer_name.description
Customer name of the resource `Llm Config`

# components.schemas.4cee7ea0_LlmConfig.properties.has_maintenance.description
Does the resource `Llm Config` have a maintenance mode enabled?

# components.schemas.4cee7ea0_LlmConfig.properties.has_operation_in_progress.description
Does the resource `Llm Config` have an operation in progress ?

# components.schemas.4cee7ea0_LlmConfig.properties.unique_id.description
Unique identifier of the resource `Llm Config`

# components.schemas.4cee7ea0_LlmConfig.properties.description.description
Description of the resource `Llm Config`

# components.schemas.4cee7ea0_LlmConfig.properties.is_free.description
Does the resource `Llm Config` have a free price status?

# components.schemas.4cee7ea0_LlmConfig.properties.is_zero_price.description
Does the resource `Llm Config` have a zero price status?

# components.schemas.4cee7ea0_LlmConfig.properties.is_trial.description
Does the resource `Llm Config` have a trial status?

# components.schemas.4cee7ea0_Tag.properties.product_count.description
Product count related to the resource `Tag`

# components.schemas.4cee7ea0_AIconfigusage.properties.current_value.description
Total consumption during the current month (in the currencty `currency_id`)

# components.schemas.4cee7ea0_AIconfigusage.properties.limitation_value.description
Consumption upper bound for a month, an error **402 Payment Required** with `maximum_token_reached` is returned if `current_value > limitation_value`

# components.schemas.4cee7ea0_AIconfigusage.properties.min_limitation_value.description
Hardcoded value `AiConfig::MIN_BUDGET_LIMIT` that is `20`

# components.schemas.4cee7ea0_AIconfigusage.properties.max_limitation_value.description
Hardcoded value `AiConfig::MAX_BUDGET_LIMIT` that is `500`

# components.schemas.4cee7ea0_V1-Staff-VirtualWait.properties.message.description
Success message telling how much the endpoint waits to respond

# components.schemas.4cee7ea0_Cohere-V1-Models.properties.next_page_token.description
A token to retrieve the next page of results.

# components.schemas.4cee7ea0_Cohere-V1-Models.description
Cohere model collection format of /v1/models

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.name.description
Specify this name in the `model` parameter of API requests to use your chosen model.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.endpoints.items.description
The API endpoints that the model is compatible with.
There is 7 possible values: `chat`, `embed`, `classify`, `summarize`, `rerank`, `rate` and `generate`.
Currently, only [`v2/rerank`](/docs/api/post/2/ai/{product_id}/cohere/v2/rerank) is available, so it will always be `["rerank"]`.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.endpoints.description
The API endpoints that the model is compatible with.
There is 7 possible values: `chat`, `embed`, `classify`, `summarize`, `rerank`, `rate` and `generate`.
Currently, only [`v2/rerank`](/docs/api/post/2/ai/{product_id}/cohere/v2/rerank) is available, so it will always be `["rerank"]`.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.finetuned.description
Whether the model has been fine-tuned or not.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.context_length.description
The maximum number of tokens that the model can process in a single request.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.tokenizer_url.description
Public URL to the tokenizer's configuration file.<br>Currently not supported.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.default_endpoints.items.description
The API endpoints that the model is default to.<br>See `endpoints`.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.default_endpoints.description
The API endpoints that the model is default to.<br>See `endpoints`.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.properties.sampling_defaults.description
Default sampling parameters for this model when omitted from API requests.

# components.schemas.4cee7ea0_Cohere-V1-Models-Model.description
Describes a model that can be used with the API.

# components.schemas.4cee7ea0_Cohere-V2-Rerank.properties.model.description
The model name used (extra non-*Cohere* field).

# components.schemas.4cee7ea0_Cohere-V2-Rerank.description
Response of *Cohere* `/v2/rerank` on **200 OK**.

# components.schemas.4cee7ea0_Cohere-V2-Rerank-Usage.properties.total_tokens.description
Total number of tokens used in the request input

# components.schemas.4cee7ea0_Cohere-V2-Rerank-Usage.description
Usage statistics (extra non-*Cohere* field).

# components.schemas.4cee7ea0_Cohere-V2-Rerank-Results.properties.index.description
Corresponds to the index in the original list of documents to which the ranked document belongs. (*i.e.* if the first value in the `results` object has an index value of `3`, it means in the list of documents passed in, the document at `index=3` had the highest relevance)

# components.schemas.4cee7ea0_Cohere-V2-Rerank-Results.properties.relevance_score.description
Relevance scores are normalized to be in the range `[0, 1]`. Scores close to `1` indicate a high relevance to the query, and scores closer to `0` indicate low relevance. It is not accurate to assume a score of `0.9` means the document is 2x more relevant than a document with a score of `0.45`.

# components.schemas.4cee7ea0_Cohere-V2-Rerank-Document.properties.text.description
The original item in `documents` in the request body.

# components.schemas.4cee7ea0_Cohere-V2-Rerank-Document.properties.text.example
Silver is the metal with the highest electrical and thermal conductivity.

# components.schemas.4cee7ea0_Cohere-V2-Rerank-Document.description
Object about the original item in `documents` (extra non-*Cohere* field).

# components.schemas.4cee7ea0_Cohere-V2-Rerank-Meta.description
Object containing various information, including consumptions<br>This *Cohere* field is not returned by our endpoint.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions.properties.id.description
A unique identifier for the chat completion.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions.properties.object.description
The object `chat.completion` if not stream mode else `chat.completion.chunk`

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions.properties.created.description
The Unix timestamp (in seconds) of when the response was created.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions.properties.service_tier.description
Specifies the processing type used for serving the request.
• If set to `auto`, then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use `default`.
• If set to `default`, then the request will be processed with the standard pricing and performance for the selected model.
• If set to [`flex`](https://platform.openai.com/docs/guides/flex-processing) or [`priority`](https://openai.com/api-priority-processing/), then the request will be processed with the corresponding service tier.
• When not set, the default behavior is 'auto'.
When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions.properties.system_fingerprint.description
**Deprecated**<br>This fingerprint represents the backend configuration that the model runs with.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions.description
OpenAI response format of /v1/chat/completions

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Choice.properties.index.description
The index of the choice in the list of choices.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Choice.properties.finish_reason.description
The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Choice.description
A list of chat completion choices. Can be more than one if `n` is greater than 1.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Message.properties.refusal.description
The refusal message generated by the model.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Message.description
A chat completion message generated by the model.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Annotations.properties.type.description
The type of the URL citation. Always `url_citation`.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Annotations.description
Annotations for the message, when applicable, as when using the *web search tool*.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-UrlCitation.properties.end_index.description
The index of the last character of the URL citation in the message.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-UrlCitation.properties.start_index.description
The index of the first character of the URL citation in the message.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Logprobs.description
Log probability information for the choice.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Content.properties.bytes.items.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Content.properties.bytes.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Content.properties.logprob.description
The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Content.description
A list of message content tokens with log probability information.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-TopLogprobs.properties.bytes.items.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-TopLogprobs.properties.bytes.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-TopLogprobs.properties.logprob.description
The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-TopLogprobs.description
List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Refusal.properties.bytes.items.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Refusal.properties.bytes.description
A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Refusal.properties.logprob.description
The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

# components.schemas.4cee7ea0_OpenAi-V1-Chat-Completions-Refusal.description
A list of message refusal tokens with log probability information.

# components.schemas.4cee7ea0_OpenAi-CompletionUsage.properties.completion_tokens.description
Number of tokens in the generated completion.

# components.schemas.4cee7ea0_OpenAi-CompletionUsage.properties.total_tokens.description
Total number of tokens used in the request (prompt + completion).

# components.schemas.4cee7ea0_OpenAi-CompletionUsage.description
Usage statistics for the completion request.

# components.schemas.4cee7ea0_OpenAi-CompletionUsage-PromptTokensDetails.properties.audio_tokens.description
Audio input tokens present in the prompt.

# components.schemas.4cee7ea0_OpenAi-CompletionUsage-CompletionTokensDetails.properties.accepted_prediction_tokens.description
When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.

# components.schemas.4cee7ea0_OpenAi-CompletionUsage-CompletionTokensDetails.properties.audio_tokens.description
Audio input tokens generated by the model.

# components.schemas.4cee7ea0_OpenAi-CompletionUsage-CompletionTokensDetails.properties.reasoning_tokens.description
Tokens generated by the model for reasoning.

# components.schemas.4cee7ea0_OpenAi-CompletionUsage-CompletionTokensDetails.properties.rejected_prediction_tokens.description
When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits.

# components.schemas.4cee7ea0_OpenAi-CompletionUsage-CompletionTokensDetails.description
Breakdown of tokens used in a completion

# components.schemas.4cee7ea0_OpenAi-V1-Completions.properties.id.description
A unique identifier for the chat completion.

# components.schemas.4cee7ea0_OpenAi-V1-Completions.properties.object.description
The object type, which is always `text_completion`

# components.schemas.4cee7ea0_OpenAi-V1-Completions.properties.created.description
The Unix timestamp (in seconds) of when the response was created.

# components.schemas.4cee7ea0_OpenAi-V1-Completions.properties.system_fingerprint.description
This fingerprint represents the backend configuration that the model runs with.<br>Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

# components.schemas.4cee7ea0_OpenAi-V1-Completions.description
OpenAI response format of /v1/completions

# components.schemas.4cee7ea0_OpenAi-V1-Completions-Choice.properties.finish_reason.description
In `"stop"`, `"length"`, `"content_filter"`.<br>The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings.properties.object.description
The object type, which is always `list`.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings.properties.model.description
The model used to create the embeddings.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings.description
OpenAI embeddings collection format of /v1/embeddings

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings-Embedding.properties.object.description
The object type, which is always `embedding`.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings-Embedding.properties.embedding.items.description
The embedding vector, which is a list of floats. The length of vector depends on the model.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings-Embedding.properties.embedding.description
The embedding vector, which is a list of floats. The length of vector depends on the model.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings-Embedding.properties.index.description
The index of the embedding in the list of embeddings.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings-Embedding.description
Represents an embedding vector returned by embedding endpoint.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings-Usage.properties.total_tokens.description
Total number of tokens used in the request, same as `prompt_tokens` for embeddings.

# components.schemas.4cee7ea0_OpenAi-V1-Embeddings-Usage.description
Usage statistics for the embeddings request.

# components.schemas.0cc1b8a9_Deal.properties.id.description
Unique identifier of the resource `Deal`

# components.schemas.0cc1b8a9_Deal.properties.stream_mountpoint.description
The stream mountpoint associate to `Deal`

# components.schemas.0cc1b8a9_KubernetesCluster.properties.id.description
Unique identifier of the resource `KubernetesCluster`

# components.schemas.0cc1b8a9_KubernetesCluster.properties.name.description
The name of the ressource `KubernetesCluster`

# components.schemas.0cc1b8a9_KubernetesCluster.properties.api_url.description
The api url to connect to apply configuration

# components.schemas.0cc1b8a9_KubernetesCluster.properties.api_token.description
The `KubernetesCluster` api token for request

# components.schemas.0cc1b8a9_KubernetesCluster.properties.namespace.description
The `KubernetesCluster` namespace to request

# components.schemas.0cc1b8a9_KubernetesCluster.properties.domain.description
The `KubernetesCluster` domain used for access to the pod

# components.schemas.0cc1b8a9_KubernetesCluster.properties.is_enabled.description
Is the resource `KubernetesCluster` enabled?

# components.schemas.0cc1b8a9_KubernetesCluster.properties.is_default.description
Is the resource `KubernetesCluster` the default resource?

# components.schemas.0cc1b8a9_KubernetesCluster.properties.created_at.description
Timestamp `KubernetesCluster` has been created

# components.schemas.0cc1b8a9_KubernetesCluster.properties.updated_at.description
Timestamp `KubernetesCluster` has been updated

# components.schemas.0cc1b8a9_ClusterPool.properties.id.description
Unique identifier of the resource `ClusterPool`

# components.schemas.0cc1b8a9_ClusterPool.properties.full_name.description
Full name of the ressource `ClusterPool`

# components.schemas.0cc1b8a9_Cluster.properties.id.description
Unique identifier of the resource `Cluster`

# components.schemas.0cc1b8a9_ClusterConfig.properties.id.description
Unique identifier of the resource `ClusterConfig`

# components.schemas.0cc1b8a9_ClusterConfig.properties.clusters.description
The cluster that are using this configuration

# components.schemas.0cc1b8a9_ClusterConfig.properties.created_at.description
Timestamp `ClusterConfig` has been created

# components.schemas.0cc1b8a9_ClusterConfig.properties.updated_at.description
Timestamp `ClusterConfig` has been updated

# components.schemas.0cc1b8a9_ClusterConfig.properties.deleted_at.description
Timestamp `ClusterConfig` has been deleted

# components.schemas.0cc1b8a9_Station.properties.id.description
Unique identifier of the resource `Station`

# components.schemas.0cc1b8a9_Station.properties.uuid.description
Universally unique identifier of the resource `Station`

# components.schemas.0cc1b8a9_Station.properties.thumbnail.description
The url to the thumbnail of the `Station`

# components.schemas.0cc1b8a9_Station.properties.log_server.description
The server name to connect to the log server

# components.schemas.0cc1b8a9_Station.properties.listeners.description
The number of currently listeners listen all `Stream`

# components.schemas.0cc1b8a9_Station.properties.slipping_consumption.description
The current monthly slipping consumption (Byte)

# components.schemas.0cc1b8a9_Station.properties.count_active_deal.description
count streams with deals for the station

# components.schemas.0cc1b8a9_Station.properties.certified_by.description
Station certified byacpm: Certified by ACPM mediapulse: Certified by Mediapulse indes: Certified like ACPM for the independents

# components.schemas.0cc1b8a9_Station.properties.certified_at.description
Last updating date of a certification organisation

# components.schemas.0cc1b8a9_Master.properties.id.description
Unique identifier of the resource `Master`

# components.schemas.0cc1b8a9_Edge.properties.id.description
Unique identifier of the resource `Edge`

# components.schemas.0cc1b8a9_AutoDJ.properties.id.description
Unique identifier of the resource `AutoDJ`

# components.schemas.0cc1b8a9_Stream.properties.id.description
Unique identifier of the resource `Stream`

# components.schemas.0cc1b8a9_Stream.properties.uuid.description
Universally unique identifier of the resource `Stream`

# components.schemas.0cc1b8a9_Stream.properties.mountpoint.description
The mountpoint to access to the `Stream`

# components.schemas.0cc1b8a9_Stream.properties.introduction_file_url.description
The audio file used before the `Stream` begin

# components.schemas.0cc1b8a9_Stream.properties.ip_include_list.description
The ip list allows to access to the stream

# components.schemas.0cc1b8a9_Stream.properties.ip_exclude_list.description
The ip list not allows to access to the stream

# components.schemas.0cc1b8a9_Stream.properties.is_allow_country.description
Define if the stream used the restriction rules

# components.schemas.0cc1b8a9_Stream.properties.country_list.description
The country list not allows to access to the stream

# components.schemas.0cc1b8a9_Stream.properties.is_source.description
Is the `Stream` used for `HlsStream` or `Transcoding` as source?

# components.schemas.0cc1b8a9_Stream.properties.listeners.description
The number of currently listeners on `Stream`

# components.schemas.0cc1b8a9_Stream.properties.fallback_id.description
The fallback id attached to this `Stream`

# components.schemas.0cc1b8a9_HlsStream.properties.use_stream_configuration.description
Used the soundcast stream configuration?

# components.schemas.0cc1b8a9_HlsStream.properties.midroll_occurrence.description
The number of secondes between each midroll

# components.schemas.0cc1b8a9_HlsStream.properties.is_metadata_midroll.description
Is the metadata detection are enabled for midroll?

# components.schemas.0cc1b8a9_HlsStream.properties.is_overwrite_midroll.description
Is the overwrite mode are enabled for midroll?

# components.schemas.0cc1b8a9_HlsStream.properties.id.description
Unique identifier of the resource `HlsStream`

# components.schemas.0cc1b8a9_HlsStream.properties.uuid.description
Universally unique identifier of the resource `HlsStream`

# components.schemas.0cc1b8a9_HlsStream.properties.buffer_size.description
The size of the buffer in the `HlsStream`

# components.schemas.0cc1b8a9_HlsStream.properties.fragment_size.description
The size of the fragment in the `HlsStream` use for buffer size

# components.schemas.0cc1b8a9_HlsStream.properties.ip_include_list.description
The ip list allows to access to the hls stream

# components.schemas.0cc1b8a9_HlsStream.properties.ip_exclude_list.description
The ip list not allows to access to the hls stream

# components.schemas.0cc1b8a9_HlsStream.properties.is_allow_country.description
Define if the hls stream used the restriction rules

# components.schemas.0cc1b8a9_HlsStream.properties.country_list.description
The country list not allows to access to the hls stream

# components.schemas.0cc1b8a9_HlsStream.properties.listeners.description
The number of currently listeners on `HlsStream`

# components.schemas.0cc1b8a9_Player.properties.display_name.description
Name of the ressource `Player` visible by final customer

# components.schemas.0cc1b8a9_Player.properties.is_metadata_display.description
Is the metadata title and artist displayed?

# components.schemas.0cc1b8a9_Player.properties.height.description
The height used for render the `Player` (px)

# components.schemas.0cc1b8a9_Player.properties.width.description
The width used for render the `Player` (px)

# components.schemas.0cc1b8a9_Player.properties.background_color.description
The background color used in the `Player`

# components.schemas.0cc1b8a9_Player.properties.secondary_color.description
The secondary color used in the `Player`

# components.schemas.0cc1b8a9_Player.properties.is_listeners.description
Is the listeners informations displayed?

# components.schemas.0cc1b8a9_Player.properties.listeners_hold.description
The listeners hold used to display listeners informations

# components.schemas.0cc1b8a9_Player.properties.facebook_link.description
The Facebook link used to Facebook embed

# components.schemas.0cc1b8a9_Player.properties.twitter_account.description
The Twitter account used to Twitter embed

# components.schemas.0cc1b8a9_Player.properties.twitter_backlink.description
The Twitter backlink used to Twitter embed

# components.schemas.0cc1b8a9_Player.properties.twitter_hashtag.description
The Twitter hashtag used to Twitter embed

# components.schemas.0cc1b8a9_Player.properties.loading.description
The url of the loading file used in the player

# components.schemas.0cc1b8a9_Player.properties.unavailable.description
The url of the unavailable file used in the player

# components.schemas.0cc1b8a9_Player.properties.restriction.description
The url of the restriction file used in the player

# components.schemas.0cc1b8a9_Player.properties.is_hls_buffered.description
Is the player start at the beginning and buffer hls streams?

# components.schemas.0cc1b8a9_Player.properties.history_display.description
The history display used in the `Player`

# components.schemas.0cc1b8a9_Player.properties.is_history_time_display.description
Is the history player time will be display ?

# components.schemas.0cc1b8a9_Player.properties.is_history_clickable.description
Is the history player could be clickable ?

# components.schemas.0cc1b8a9_Player.properties.id.description
Unique identifier of the resource `Player`

# components.schemas.0cc1b8a9_Player.properties.uuid.description
Universally unique identifier of the resource `Player`

# components.schemas.0cc1b8a9_CustomField.properties.cluster_pool_id.description
Unique identifier of the resource `ClusterPool`

# components.schemas.0cc1b8a9_CustomField.properties.created_at.description
Timestamp `CustomField` has been created

# components.schemas.0cc1b8a9_CustomField.properties.updated_at.description
Timestamp `CustomField` has been updated

# components.schemas.0cc1b8a9_BatchClusterMigration.properties.id.description
Unique identifier of the resource `BatchClusterMigration`

# components.schemas.0cc1b8a9_StationHistory.properties.one_day_old_stations.description
Count of stations created during last day

# components.schemas.0cc1b8a9_StationHistory.properties.one_week_old_station.description
Count of stations created during last week

# components.schemas.0cc1b8a9_StationHistory.properties.two_weeks_old_station.description
Count of stations created during last two weeks

# components.schemas.0cc1b8a9_StationHistory.properties.one_month_old_station.description
Count of stations created during last month

# components.schemas.0cc1b8a9_StationHistory.properties.three_month_old_station.description
Count of stations created during last three month

# components.schemas.0cc1b8a9_Pack.properties.id.description
Unique identifier of the resource `Pack`

# components.schemas.0cc1b8a9_Pack.properties.max_bitrate.description
The max bitrate can be used for create a `Stream` (KiloBit)

# components.schemas.0cc1b8a9_Pack.properties.max_bandwidth.description
The max bandwidth can be used in total of all `Station`(Byte)

# components.schemas.0cc1b8a9_Pack.properties.max_free_autodj_size.description
The max free AutoDJ space can be used in VOD (GigaByte)

# components.schemas.0cc1b8a9_PackPrice.properties.id.description
Unique identifier of the resource `PackPrice`

# components.schemas.0cc1b8a9_PackPrice.properties.periodicity_id.description
Unique identifier of the resource `Periodicity`

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.use_stream_configuration.description
Used the soundcast stream configuration?

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.midroll_occurrence.description
The number of secondes between each midroll

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.is_metadata_midroll.description
Is the metadata detection are enabled for midroll?

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.is_overwrite_midroll.description
Is the overwrite mode are enabled for midroll?

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.id.description
Unique identifier of the resource `HlsStreamForMetadataApi`

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.fragment_size.description
The size of the fragment in the `HlsStream`

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.station_id.description
The station id attached to this `HlsStream`

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.source_codec.description
The source `Stream` codec of the `HlsStream`

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.preroll_tag.description
The source `Stream` custom fields of the `HlsStream`

# components.schemas.0cc1b8a9_HlsStreamForMetadataApi.properties.midroll_tag.description
The source `Stream` custom fields of the `HlsStream`

# components.schemas.0cc1b8a9_StreamForMetadataApi.properties.id.description
Unique identifier of the resource `StreamForMetadataApi`

# components.schemas.0cc1b8a9_StreamForMetadataApi.properties.mountpoint.description
The mountpoint to access to the `Stream`

# components.schemas.0cc1b8a9_StreamForMetadataApi.properties.station_id.description
The station id attached to this `Stream`

# components.schemas.0cc1b8a9_StreamForMetadataApi.properties.subdomain.description
The station subdomain attached to this `Stream`

# components.schemas.0cc1b8a9_StreamForMetadataApi.properties.cluster_id.description
The cluster id attached to this `Stream`

# components.schemas.0cc1b8a9_Option.properties.id.description
Unique identifier of the resource `Option`

# components.schemas.0cc1b8a9_OptionPrice.properties.id.description
Unique identifier of the resource `OptionPrice`

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.artist.description
The current artist name of the played music

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.background_color.description
The background color used in the `Player`

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.cover.description
The current cover url of the played music

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.display_name.description
Name of the ressource `Player` visible by final customer

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.facebook_link.description
The Facebook link used to Facebook embed

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.height.description
The height used for render the `Player` (px)

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.history_display.description
The history display used in the `Player`

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.id.description
Unique identifier of the resource `Player`

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.is_history_clickable.description
Is the history player could be clickable ?

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.is_history_time_display.description
Is the history player time will be display ?

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.is_listeners.description
Is the listeners informations displayed?

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.is_metadata_display.description
Is the metadata title and author is enabled?

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.is_station_thumbnail.description
Is the station thumbnail we be displayed like cover?

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.is_hls_buffered.description
Is the player start at the beginning and buffer hls streams?

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.listeners.description
The current number of listeners on the station

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.listeners_hold.description
The minimum number of listeners to display listeners

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.loading.description
The url of the loading file used in the player

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.restriction.description
The url of the restriction file used in the player

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.secondary_color.description
The secondary color used in the `Player`

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.timeline.description
The list of last songs played on the station

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.title.description
The current artist title of the played music

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.twitter_account.description
The Twitter account used to Twitter embed

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.twitter_backlink.description
The Twitter backlink used to Twitter embed

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.twitter_hashtag.description
The Twitter hashtag used to Twitter embed

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.unavailable.description
The url of the unavailable file used in the player

# components.schemas.0cc1b8a9_PlayerConfiguration.properties.width.description
The width used for render the `Player` (px)

# components.schemas.0cc1b8a9_RadioProduct.properties.locked_at.description
Timestamp `RadioProduct` has been locked

# components.schemas.0cc1b8a9_RadioProduct.properties.has_maintenance.description
Does the resource `RadioProduct` have a maintenance mode enabled?

# components.schemas.0cc1b8a9_RadioProduct.properties.listeners.description
The number of currently listeners listen all `Stream`

# components.schemas.0cc1b8a9_RadioProduct.properties.count_active_deal.description
count stations with deals for the radio_product

# components.schemas.0cc1b8a9_RadioProduct.properties.created_at.description
Timestamp `RadioProduct` has been created

# components.schemas.0cc1b8a9_RadioProduct.properties.updated_at.description
Timestamp `RadioProduct` has been updated

# components.schemas.0cc1b8a9_RadioProduct.properties.deleted_at.description
Timestamp `RadioProduct` has been deleted

# components.schemas.0cc1b8a9_RadioProductOptionShop.properties.id.description
Unique identifier of the resource `RadioProductOptionShop`

# components.schemas.0cc1b8a9_RadioProductOptionShop.properties.type.description
Type of the resource `RadioProductOptionShop`

# components.schemas.0cc1b8a9_User.properties.id.description
Unique identifier of the resource `User`

# components.schemas.0cc1b8a9_Station_e0573969.properties.id.description
Unique identifier of the resource `Station`

# components.schemas.0cc1b8a9_Station_e0573969.properties.thumbnail.description
The url to the thumbnail of the `Station`

# components.schemas.0cc1b8a9_StreamSimplify.properties.id.description
Unique identifier of the resource `Stream`

# components.schemas.0cc1b8a9_StreamSimplify.properties.is_source.description
Define if the stream is used like a source for HlsStream or Transcoding

# components.schemas.0cc1b8a9_StatListener.properties.listeners_30s.description
The number of listeners will stay 30 seconds

# components.schemas.0cc1b8a9_StatListener.properties.sub_unique_listeners.description
The number of unique listeners for the sub model(Station or Stream)

# components.schemas.0cc1b8a9_StatListener.properties.listening_time_30s.description
The number of seconds listened with listener stay at least 30 seconds

# components.schemas.0cc1b8a9_StatCountry.properties.streams.description
The list of streams call in this country (only available on stations stats)

# components.schemas.0cc1b8a9_StatCountry.properties.stations.description
The list of stations call in this country (only available on radio products stats)

# components.schemas.0cc1b8a9_StatCountry.properties.listeners_30s.description
The number of listeners who stay more than 30 secondes

# components.schemas.0cc1b8a9_StatCountry.properties.average_listeners_30s_by_day.description
The number of listeners per day who stay more than 30 secondes

# components.schemas.0cc1b8a9_ContinentMetric.properties.SA.description
The number of listeners in South America

# components.schemas.0cc1b8a9_ContinentMetric.properties.NA.description
The number of listeners in North America

# components.schemas.0cc1b8a9_StatListenerByStation.properties.listeners_30s.description
The number of listeners will stay 30 seconds

# components.schemas.0cc1b8a9_StatListenerByStation.properties.average_listening_time.description
The average of seconds listened on the date range

# components.schemas.0cc1b8a9_StatConsumption.properties.average_bytes_by_listeners.description
The average of bytes consumed by listener

# components.schemas.0cc1b8a9_StatConsumptionByStream.properties.total_bytes.description
The total of bytes consumed on the date range

# components.schemas.0cc1b8a9_StatConsumptionByStream.properties.average_bytes_by_listeners.description
The average of bytes consumed by listeners

# components.schemas.0cc1b8a9_StatTotalPlayer.properties.streams.description
The list of streams use this player (only available on stations stats)

# components.schemas.0cc1b8a9_StatTotalPlayer.properties.stations.description
The list of stations use this player (only available on radio products stats)

# components.schemas.0cc1b8a9_StatTotalPlayer.properties.percent_listeners.description
The percent of listeners of the player total

# components.schemas.0cc1b8a9_StatListLink.properties.status.description
The url link to call to get status on each streams

# components.schemas.0cc1b8a9_StatListLink.properties.status_per_stream.items.description
The url list to call to get status stream

# components.schemas.0cc1b8a9_StatListLink.properties.status_per_stream.description
The url list to call to get status stream

# components.schemas.0cc1b8a9_StatListLink.properties.instant_customer.description
The url link to call to get number of listeners on each streams

# components.schemas.0cc1b8a9_StatListLink.properties.instant_customer_per_stream.items.description
The url list to call to get number of listeners on stream

# components.schemas.0cc1b8a9_StatListLink.properties.instant_customer_per_stream.description
The url list to call to get number of listeners on stream

# components.schemas.0cc1b8a9_StatListLink.properties.mediastats_per_stream.items.description
The url list to call to get mediastats on stream

# components.schemas.0cc1b8a9_StatListLink.properties.mediastats_per_stream.description
The url list to call to get mediastats on stream

# components.schemas.0cc1b8a9_StatListLink.properties.update_metadata.description
The url link to call to change metadata of your station

# components.schemas.0cc1b8a9_Notification.properties.is_monday.description
Is the users can be notified the monday ?

# components.schemas.0cc1b8a9_Notification.properties.is_tuesday.description
Is the users can be notified the tuesday ?

# components.schemas.0cc1b8a9_Notification.properties.is_wednesday.description
Is the users can be notified the wednesday ?

# components.schemas.0cc1b8a9_Notification.properties.is_thursday.description
Is the users can be notified the thursday ?

# components.schemas.0cc1b8a9_Notification.properties.is_friday.description
Is the users can be notified the friday ?

# components.schemas.0cc1b8a9_Notification.properties.is_saturday.description
Is the users can be notified the saturday ?

# components.schemas.0cc1b8a9_Notification.properties.is_sunday.description
Is the users can be notified the sunday ?

# components.schemas.0cc1b8a9_PlayingMedia.properties.id.description
Unique identifier of the resource `PlayingMedia`

# components.schemas.0cc1b8a9_PlayingMedia.properties.is_under_live.description
The `PlayingMedia` will be played if live stream is not on

# components.schemas.0cc1b8a9_PlayingMedia.properties.has_perfect_timing.description
The `PlayingMedia` will be played at the exact started_at

# components.schemas.0cc1b8a9_PlanningEvent.properties.id.description
Unique identifier of the resource `PlanningEvent`

# components.schemas.0cc1b8a9_Media.properties.artists.description
The time before the same song can be replayed

# components.schemas.0cc1b8a9_Media.properties.cover.description
The time before the same song can be replayed

# components.schemas.0cc1b8a9_Media.properties.duration.description
The time before the same song can be replayed

# components.schemas.0cc1b8a9_Media.properties.advanced_playlist_step_id.description
UUID of the advanced playlist step (null if from default fill)

# components.schemas.0cc1b8a9_AdvancedPlaylistCycle.properties.total_medias.description
Total number of medias picked across all cycles

# components.schemas.0cc1b8a9_Playlist.properties.is_advanced.description
Whether this playlist is a composite/advanced playlist

# components.schemas.0cc1b8a9_StatListenerByStation_21e42669.properties.listeners_30s.description
The number of listeners will stay 30 seconds

# components.schemas.0cc1b8a9_StatListenerByStation_21e42669.properties.average_listening_time.description
The average of seconds listened on the date range

# components.schemas.0cc1b8a9_StatConsumptionByStation.properties.total_bytes.description
The total of bytes consumed on the date range

# components.schemas.0cc1b8a9_StatConsumptionByStation.properties.average_bytes_by_listeners.description
The average of bytes consumed by listeners

# components.schemas.0cc1b8a9_StreamMaster.properties.id.description
Unique identifier of the resource `StreamMaster`

# components.schemas.0cc1b8a9_StreamMaster.properties.uuid.description
Universally unique identifier of the resource `StreamMaster`

# components.schemas.0cc1b8a9_Station_1dfd1c4c.properties.id.description
Unique identifier of the resource `Station`

# components.schemas.0cc1b8a9_Station_1dfd1c4c.properties.thumbnail.description
The url to the thumbnail of the `Station`

# components.schemas.0cc1b8a9_Station_1dfd1c4c.properties.streams.description
The list of streams with relay and transcoded streams

# components.schemas.0cc1b8a9_StreamStored.properties.id.description
Unique identifier of the resource `Stream`

# components.schemas.0cc1b8a9_StreamStored.properties.fallback_mountpoint.description
The mountpoint used to fallback the stream

# components.schemas.0cc1b8a9_StreamStored.properties.is_source.description
Define if the stream is used like a source for HlsStream or Transcoding

# components.schemas.0cc1b8a9_StreamStored.properties.is_transcoding.description
Define if the stream is a transcoded stream

# components.schemas.a9a5e581_Converter.properties.outputGroups.description
Defined transcoding output format groups

# components.schemas.a9a5e581_Storage.properties.type.description
Storage kind (s3, ftp, sftp, kdrive, vod)

# components.schemas.a9a5e581_Storage.properties.managed.description
Whether the storage is managed by the platform

# components.schemas.a9a5e581_WorkflowRun.properties.run_id.description
Unique run identifier (one per execution attempt)

# components.schemas.a9a5e581_WorkflowRun.properties.name.description
Workflow type name (e.g. TranscodeMediaWorkflow)

# components.schemas.a9a5e581_WorkflowRun.properties.status.description
Current execution status: running, completed, failed or cancelled

# components.schemas.a9a5e581_WorkflowRun.properties.finished_at.description
When the workflow execution finished (null when running)

# components.schemas.a9a5e581_WorkflowRun.properties.attempts.description
Number of past runs for this workflow id (starts at 1)

# components.schemas.a9a5e581_WorkflowRun.properties.queued.description
Whether the workflow is waiting for a tenant gate permit

# components.schemas.a9a5e581_WorkflowRun.properties.payload.description
Original input arguments forwarded to the workflow

# components.schemas.a9a5e581_WorkflowRun.properties.memo.description
Arbitrary key-value data persisted with the execution

# components.schemas.a9a5e581_WorkflowRun.properties.activities.description
Ordered list of activity attempts in this run

# components.schemas.a9a5e581_WorkflowDAG.properties.nodes.description
Ordered list of execution steps in the plan

# components.schemas.a9a5e581_WorkflowDAG.properties.edges.description
Directed happens-before edges between nodes

# components.schemas.a9a5e581_WorkflowDAG.properties.degraded.description
True when the graph was rebuilt from activity history (no memo)

# components.schemas.a9a5e581_WorkflowDAGNode.properties.id.description
Stable node identifier inside the graph (e.g. n0, n1)

# components.schemas.a9a5e581_WorkflowDAGNode.properties.progress_id.description
Predictable step instance id used to map live progress events to this node (e.g. ProbeMedia-0)

# components.schemas.a9a5e581_WorkflowDAGNode.properties.progress_topic.description
RPS MQTT topic to subscribe to for per-instance progress updates

# components.schemas.a9a5e581_WorkflowDAGNode.properties.name.description
Activity or step type name as registered in Temporal

# components.schemas.a9a5e581_WorkflowDAGNode.properties.type.description
Dispatch kind: activity, local_activity or workflow

# components.schemas.a9a5e581_WorkflowDAGNode.properties.group.description
Output group name this node belongs to; empty for shared nodes (e.g. probes) not tied to a single output group

# components.schemas.a9a5e581_WorkflowDAGNode.properties.progress_exempt.description
When true the step does not count toward overall progress

# components.schemas.a9a5e581_Callback.properties.label.description
Human-readable label for the callback configuration

# components.schemas.a9a5e581_Callback.properties.url.description
Target URL called when the callback fires

# components.schemas.a9a5e581_Callback.properties.auth_type.description
Authentication scheme (none, basic, bearer, etc.)

# components.schemas.a9a5e581_Callback.properties.headers.description
Additional HTTP headers sent with requests

# components.schemas.a9a5e581_Callback.properties.retry_max.description
Maximum number of retry attempts on failure

# components.schemas.a9a5e581_Callback.properties.retry_backoff_ms.description
Backoff delay between retries in milliseconds

# components.schemas.a9a5e581_Callback.properties.subscriptions.description
Event subscriptions tied to this callback

# components.schemas.a9a5e581_CallbackSubscription.properties.job_type.description
Job type that triggers this subscription

# components.schemas.a9a5e581_CallbackSubscription.properties.workflow.description
Workflow type that triggers this subscription

# components.schemas.a9a5e581_CallbackSubscription.properties.activity.description
Activity type that triggers this subscription

# components.schemas.a9a5e581_Pack.properties.meta.description
Pack metadata such as features and limits

# components.schemas.a9a5e581_PackMeta.properties.features.description
Pack features included in the subscription

# components.schemas.a9a5e581_PackFeature.properties.included.description
Whether the feature is included in the pack

# components.schemas.91ac10ff_NavigatorResponse.title
Generic success response schema for Navigator

# components.schemas.91ac10ff_NavigatorResponse.properties.cursor.description
Cursor pagination uses a cursor to track the current position in the dataset. This cursor should be passed back in the subsequent API request in order to retrieve the next set of results or page of the list.

# components.schemas.91ac10ff_NavigatorResponse.properties.has_more.description
The has_more boolean flag indicates whether additional items are available beyond the current page of results.

# components.schemas.91ac10ff_NavigatorResponse.properties.response_at.description
The timestamp, in seconds, indicating when the dataset was generated.

# components.schemas.91ac10ff_Drive.properties.maintenance_reason.description
Reason of Drive maintenance.demo_end: The demonstration period of the Drive has come to an end. invoice_overdue: An invoice for this Drive is currently unpaid. not_renew: This Drive has expired and must be renewed.

# components.schemas.91ac10ff_Drive.properties.maintenance_types.description
Types of maintenances.asleep: The Drive is inactive, cannot perform requested operation. An API call will wake it up asynchronously. hard_delete: The Drive and its storage are being hard deleted, cannot perform requested operation. manager_in_maintenance: Drive is in maintenance, cannot perform requested operation. manager_is_blocked: Drive is blocked, cannot perform requested operation. move_ns: The Drive is being moved to another namespace, cannot perform requested operation. move_sql_cluster: The Drive database is being moved, cannot perform requested operation. move_sql_master: The Drive database main instance is being moved, cannot perform requested operation. rewind: A restoration is being applied, cannot perform requested operation. uninitializing: The Drive never had any significant activity so it is being uninitialized, cannot perform requested operation. upgrade_schema: The Drive database is being upgraded, cannot perform requested operation. waking_up: The Drive was inactive but is in the process of waking up, cannot perform requested operation for now.

# components.schemas.91ac10ff_Drive.properties.account_id.description
Id of the account in which the kDrive is

# components.schemas.91ac10ff_Drive.properties.role.description
Role of the current user within this kDrive

# components.schemas.91ac10ff_Drive.properties.account_admin.description
Whether user is an administrator of the current kDrive account

# components.schemas.91ac10ff_Drive.properties.is_in_app_subscription.description
Whether this drive has been purchased within an app store

# components.schemas.91ac10ff_Drive.properties.users.properties.external.items.description
Users identifiers of the drive (only externals users)

# components.schemas.91ac10ff_Drive.properties.users.properties.external.description
Users identifiers of the drive (only externals users)

# components.schemas.91ac10ff_Drive.properties.users.properties.internal.items.description
Users identifiers of the drive (only internal users)

# components.schemas.91ac10ff_Drive.properties.users.properties.internal.description
Users identifiers of the drive (only internal users)

# components.schemas.91ac10ff_Drive.properties.capabilities.properties.can_use_rag.description
Can use RAG AI assistant on document content

# components.schemas.91ac10ff_Drive.properties.capabilities.properties.search.description
Active search capabilities of the kDrive

# components.schemas.91ac10ff_Drive.properties.settings.properties.versioning.properties.max_numbers.description
Number of versions that can be kept if active

# components.schemas.91ac10ff_Drive.properties.settings.properties.versioning.properties.max_days.description
Maximum number of days versions are kept

# components.schemas.91ac10ff_Drive.properties.settings.properties.office.properties.presentation.description
Default current application for presentation document.365: The 365 application. collabora: The collabora application. onlyoffice: The onlyoffice application.

# components.schemas.91ac10ff_Drive.properties.settings.properties.office.properties.spreadsheet.description
Default current application for spreadsheet document.365: The 365 application. collabora: The collabora application. onlyoffice: The onlyoffice application.

# components.schemas.91ac10ff_Drive.properties.settings.properties.office.properties.text.description
Default current application for text document.365: The 365 application. collabora: The collabora application. onlyoffice: The onlyoffice application.

# components.schemas.91ac10ff_Drive.properties.settings.properties.office.properties.default_mode.description
OnlyOffice display mode.desktop: Optimized for the display in desktop computer browsers. embedded: Optimized for embedding the documents into a website page. mobile: Optimized for the display in mobile device browsers.

# components.schemas.91ac10ff_Drive.properties.settings.properties.max_keep_deleted_user.description
Max time the files of an user deleted is kept

# components.schemas.91ac10ff_Drive.properties.settings.properties.files.properties.private.properties.size_threshold.description
Size quota for private directory. <note>Size in bytes, value is null if no limit has been set on private folders.</note>

# components.schemas.91ac10ff_Drive.properties.settings.properties.report.properties.storage_report.properties.frequency.description
Report frequency.monthly: Sent every month. never: Never sent. semi-monthly: Sent every two week. weekly: Sent every week.

# components.schemas.91ac10ff_Drive.properties.settings.description
Settings of the current users for this kDrive

# components.schemas.91ac10ff_Drive.properties.preferences.properties.hide.description
Is the drive hidden for the current user

# components.schemas.91ac10ff_Drive.properties.preferences.properties.default.description
The default drive chosen by the user, if none the first drive in the list should be considered the default. There should only be one default drive.

# components.schemas.91ac10ff_Drive.properties.preferences.properties.ui.properties.storage_warning_alert.description
Display an alert when storage limit is about to be reached

# components.schemas.91ac10ff_Drive.properties.preferences.properties.ui.properties.storage_limit_alert.description
Display an alert when storage limit has been reached

# components.schemas.91ac10ff_Drive.properties.preferences.properties.ui.properties.rag_ocr_promotion.description
Display a promotion message about the RAG OCR if the user has not seen it yet

# components.schemas.91ac10ff_MaintenanceType.properties.description.description
Short explanation of active Maintenance Type

# components.schemas.91ac10ff_Account.properties.id.description
Unique identifier of the resource `Account`

# components.schemas.91ac10ff_RewindV3.properties.status.description
Rewind status.canceled: Rewind was canceled by the user and deleted. done: Rewind completed successfully. drive_not_ready: Rewind cannot start because the drive was not ready (uploads or actions in progress).expired: Rewind has expired and deleted. failed: Rewind completed with errors. in_progress: Rewind is currently in progress. new: Rewind did not start. sanitizing: Rewind find the activity to sanitize. waiting_approval: Rewind waiting user approval to continue.

# components.schemas.91ac10ff_RewindV3.properties.mode.description
Rewind type.directory: Rewind only a directory. drive: Rewind all the drive. user: Rewind a user's private folder.

# components.schemas.91ac10ff_RewindV3.properties.archiving.description
Rewind archive mode, all created files between now and the rewind date will be set to trash or to an archive depending on the mode selected.all: Keep in an archive folder the current or trashed files. current: Keep in an archive folder the current files. none: Don't build an archive, trash all created files.

# components.schemas.91ac10ff_RewindV3.properties.directory_id.description
The targeted directory of the rewind <note>Filled only in directory and user mode</note>

# components.schemas.91ac10ff_RewindV3.properties.directory_name.description
The name of the directory selected when the directory mode is selected

# components.schemas.91ac10ff_RewindV3.properties.user_id.description
The targeted user of the rewind <note>Filled only in user mode</note>

# components.schemas.91ac10ff_RewindV3.properties.finished_at.description
when the rewind is executed the finished process time is save here

# components.schemas.91ac10ff_RewindV3.properties.rewind_name.description
The name of the directory choose during approval step

# components.schemas.91ac10ff_RewindV3.properties.sanitizer.description
Sanitizer resume, returned only when the rewind has done the sanitizing process

# components.schemas.91ac10ff_RewindV3.properties.summary.description
Rewind resume, returned only when the rewind is finished

# components.schemas.91ac10ff_DirectoryV3.properties.id.description
Unique identifier of the resource `Directory V3`

# components.schemas.91ac10ff_DirectoryV3.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_DirectoryV3.properties.status.description
Current state of Directory V3. The state can be null meaning that the Directory V3 has no specific state.locked: Directory V3 is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Directory V3 is available. trash_inherited: Directory V3 is currently in trash because a parent directory was trashed. trashed: Directory V3 is currently in trash and specifically trashed by the user. uploading: Directory V3 is currently being uploaded. The Directory V3 is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_DirectoryV3.properties.visibility.description
Visibility of Directory V3, empty string if no specific visibility. Add additional information about Directory V3 to show different icons or more.: Empty visibility mean no special visibility. is_in_private_space: Is a Directory V3 inside the private directory of the user. is_in_shared_space: Is a Directory V3 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_in_team_space_folder: Is a Directory V3 inside a Common Documents directory. is_private_space: Is the private directory of the user. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_DirectoryV3.properties.created_by.description
The identifier of the user who first uploaded the Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.created_at.description
Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_DirectoryV3.properties.added_at.description
The timestamp (in seconds) at which the Directory V3 has been uploaded for the first time

# components.schemas.91ac10ff_DirectoryV3.properties.last_modified_at.description
Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_DirectoryV3.properties.last_modified_by.description
Id of the user who last modified the Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.revised_at.description
The last time the content of the Directory V3 was revised

# components.schemas.91ac10ff_DirectoryV3.properties.updated_at.description
The last time the Directory V3 was updated

# components.schemas.91ac10ff_DirectoryV3.properties.deleted_at.description
Timestamp of deleted resource Directory V3, only visible when the Directory V3 is trashed

# components.schemas.91ac10ff_DirectoryV3.properties.deleted_by.description
User identifier of deleted resource Directory V3, only visible when the Directory V3 is trashed

# components.schemas.91ac10ff_DirectoryV3.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_DirectoryV3.properties.users.items.description
Array of users identifiers that has access to the Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.users.description
Array of users identifiers that has access to the Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.teams.items.description
Array of teams identifiers that has access to the Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.teams.description
Array of teams identifiers that has access to the Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.activity.description
Activities information about the Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_DirectoryV3.properties.capabilities.properties.can_share.description
Right to share Directory V3 or manage access to Directory V3

# components.schemas.91ac10ff_DirectoryV3.properties.capabilities.properties.can_become_dropbox.description
Right to use convert directory into collaborative directory

# components.schemas.91ac10ff_DirectoryV3.properties.capabilities.properties.colorable.description
Right to change or add color to the directory

# components.schemas.91ac10ff_DirectoryV3.properties.lock.properties.locked_at.description
When Directory V3 is locked, locked timestamp

# components.schemas.91ac10ff_DirectoryV3.properties.lock.properties.unlocked_at.description
When Directory V3 is locked, automatic lock release timestamp

# components.schemas.91ac10ff_DirectoryV3.properties.lock.properties.description.description
List of applications.365: The 365 application. external_import: The external_import application. internal_copy: The internal_copy application. internal_import: The internal_import application. onlyoffice: The onlyoffice application. webdav: The webdav application.

# components.schemas.91ac10ff_DirectoryV3.properties.lock.properties.token.description
When Directory V3 is locked, locked token

# components.schemas.91ac10ff_DirectoryV3.properties.lock.description
When Directory V3 is locked, locked information

# components.schemas.91ac10ff_DirectoryV3.properties.color.description
Color of the directory for the user requesting it

# components.schemas.91ac10ff_ShareLink.properties.right.description
Rights required to view the share link.inherit: Share link is accessible only by users of the drive. password: Share link is public but protected by a password. public: Share link is public, no restriction set.

# components.schemas.91ac10ff_ShareLink.properties.created_by.description
Unique identifier of the creator of the resource `Share Link`

# components.schemas.91ac10ff_ShareLink.properties.capabilities.properties.can_request_access.description
Does share link allow user to request access to folder

# components.schemas.91ac10ff_ShareLink.properties.views.description
Number of views of share link (last 180 days only)

# components.schemas.91ac10ff_FileCategory.properties.added_at.description
Time when the category was added to file

# components.schemas.91ac10ff_FileCategory.properties.user_validation.description
State of user validation after auto assignment from AI.

# components.schemas.91ac10ff_FileCategory.properties.is_generated_by_ai.description
Whether the Category was generated by an AI or not

# components.schemas.91ac10ff_Category.properties.is_predefined.description
If the Category is system or user defined

# components.schemas.91ac10ff_Category.properties.created_by.description
Unique identifier of the creator of the resource `Category`

# components.schemas.91ac10ff_Dropbox.properties.id.description
Unique identifier of the resource `Dropbox`

# components.schemas.91ac10ff_Dropbox.properties.users_count.description
Number of recorded users that uploaded in the dropbox

# components.schemas.91ac10ff_Dropbox.properties.created_by.description
Unique identifier of the creator of the resource `Dropbox`

# components.schemas.91ac10ff_Dropbox.properties.last_uploaded_at.description
Last time someone uploaded a file in the dropbox

# components.schemas.91ac10ff_Dropbox.properties.capabilities.properties.has_password.description
A password was defined to access to the dropbox

# components.schemas.91ac10ff_Dropbox.properties.capabilities.properties.has_notification.description
Notification was enabled on the dropbox, email we be send to dropbox owner when someone upload a file

# components.schemas.91ac10ff_Dropbox.properties.capabilities.properties.has_validity.description
A validity period was set to the dropbox, after the date define the dropbox is not accessible

# components.schemas.91ac10ff_Dropbox.properties.capabilities.properties.has_size_limit.description
A limit size was defined to the dropbox, after the date define the dropbox is not accessible

# components.schemas.91ac10ff_AppUser.properties.id.description
Unique identifier of the resource `App User`

# components.schemas.91ac10ff_AppUser.properties.is_sso.description
returns true if the user is provided by an external IDP

# components.schemas.91ac10ff_AppUser.properties.avatar.description
null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar

# components.schemas.91ac10ff_AppUser.properties.security.properties.double_auth_method.description
Double authentication method used to log in

# components.schemas.91ac10ff_AppUser.properties.security.properties.has_double_auth.description
Whether the `App User` has double authentication enabled

# components.schemas.91ac10ff_AppUser.properties.security.properties.last_password_at.description
Last time `App User`'s password was changed

# components.schemas.91ac10ff_AppUser.properties.security.properties.has_valid_email.description
Whether the `App User` has a valid email

# components.schemas.91ac10ff_AppUser.properties.security.properties.has_recovery_email.description
Whether the `App User` has a recovery email

# components.schemas.91ac10ff_AppUser.properties.security.properties.has_valid_phone.description
Whether the `App User` has a valid phone number

# components.schemas.91ac10ff_ExternalImport.properties.application.description
Service from which the import originates.dropbox: Import from Dropbox. kdrive: Import from another kDrive. kdrive_sharelink: Import from a kDrive sharelink. onedrive: Import from Microsoft OneDrive.

# components.schemas.91ac10ff_ExternalImport.properties.status.description
External import status.canceled: External import was canceled. canceling: External import is being canceled. done: External import is finished. failed: External import failed. in_progress: External import is currently in progress. queued: External import is waiting for a process to handle it. waiting: External import has not started yet.

# components.schemas.91ac10ff_ExternalImport.properties.error_code.description
Give an error code if the failed reason is known.

# components.schemas.91ac10ff_ExternalImport.properties.directory_id.description
Import directory identifier destination (if was not deleted)

# components.schemas.91ac10ff_ExternalImport.properties.created_at.description
Timestamp `External Import` was created at

# components.schemas.91ac10ff_ExternalImport.properties.updated_at.description
Timestamp `External Import` was updated at

# components.schemas.91ac10ff_Categorypermission.properties.can_delete.description
User can delete categories and remove them from files

# components.schemas.91ac10ff_Categorypermission.properties.can_read_on_file.description
User can read the categories that are present on files

# components.schemas.91ac10ff_Tag.properties.product_count.description
Product count related to the resource `Tag`

# components.schemas.91ac10ff_PricingPlan.properties.id.description
Unique identifier of the resource `Pricing Plan`

# components.schemas.91ac10ff_PricingPlan.properties.limits.properties.users.description
Get users number limit of the Pricing Plan

# components.schemas.91ac10ff_PricingPlan.properties.limits.properties.trash.properties.retention_options.items.description
Available options for setting trash retention.one_month: 30 days. one_year: A year. six_months: 180 days. three_months: 90 days. two_months: 60 days.

# components.schemas.91ac10ff_PricingPlan.properties.limits.properties.trash.properties.retention_options.description
Available options for setting trash retention.one_month: 30 days. one_year: A year. six_months: 180 days. three_months: 90 days. two_months: 60 days.

# components.schemas.91ac10ff_PricingPlan.properties.limits.properties.storage.properties.min.description
Minimum number of additional storage (in gigabyte)

# components.schemas.91ac10ff_PricingPlan.properties.limits.properties.storage.properties.max.description
Maximum number of additional storage (in gigabyte)

# components.schemas.91ac10ff_PricingPlan.properties.limits.description
Get the users and storage limits of the Pricing Plan

# components.schemas.91ac10ff_PricingPlan.properties.prices.description
Price of the Pricing Plan, contains basic plan and additional storages and users prices by currency

# components.schemas.91ac10ff_PricingPlan.properties.capabilities.properties.can_set_sharelink_password.description
Public link can be protected by password

# components.schemas.91ac10ff_PricingPlan.properties.capabilities.properties.can_join_sharelink.description
Users with Infomaniak account can ask to join drive via public links

# components.schemas.91ac10ff_PricingPlan.properties.capabilities.properties.can_use_content_search.description
Can activate advanced search functions in file contents

# components.schemas.91ac10ff_PricingPlan.properties.capabilities.properties.can_set_office.description
Can change office editor or office related settings

# components.schemas.91ac10ff_PricingPlan.properties.capabilities.properties.start_guide_pdf.description
Add the start guide PDF to the private folder for new users

# components.schemas.91ac10ff_PricingPlan.properties.capabilities.properties.can_use_rag.description
Can ask AI assistant questions about the content of an open document

# components.schemas.91ac10ff_PricingPlan.properties.capabilities.description
Locked/Unlocked features of the Pricing Plan

# components.schemas.91ac10ff_Drivepackprice.properties.type.description
Drive pack price type, Base: standard price, User : Additional user price, Storage_giga : Additional storage price

# components.schemas.91ac10ff_Team.properties.id.description
Unique identifier of the resource `Team`

# components.schemas.91ac10ff_Team.properties.color_id.description
Unique identifier of the `color` of the resource `Team`

# components.schemas.91ac10ff_Team.properties.owned_by_id.description
Unique identifier of the `user` that owned the resource `Team`

# components.schemas.91ac10ff_Team.properties.created_by_id.description
Unique identifier of the `user` that created the resource `Team`

# components.schemas.91ac10ff_Team.properties.user_count.description
User count related to the resource `Team`

# components.schemas.91ac10ff_Team.properties.product_count.description
Product count related to the resource `Team`

# components.schemas.91ac10ff_Team.properties.product_by_service_count.description
Product by service count related to the resource `Team`

# components.schemas.91ac10ff_DriveUser.properties.id.description
Unique identifier of the resource `Drive User`

# components.schemas.91ac10ff_DriveUser.properties.is_sso.description
returns true if the user is provided by an external IDP

# components.schemas.91ac10ff_DriveUser.properties.avatar.description
null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar

# components.schemas.91ac10ff_DriveUser.properties.type.description
Type of the access; this field is no longer used and has been replaced by an additional role property `external`.main: User has access to the drive. shared: User has access to a shared file / directory only.

# components.schemas.91ac10ff_DriveUser.properties.security.properties.double_auth_method.description
Double authentication method used to log in

# components.schemas.91ac10ff_DriveUser.properties.security.properties.has_double_auth.description
Whether the `Drive User` has double authentication enabled

# components.schemas.91ac10ff_DriveUser.properties.security.properties.last_password_at.description
Last time `Drive User`'s password was changed

# components.schemas.91ac10ff_DriveUser.properties.security.properties.has_valid_email.description
Whether the `Drive User` has a valid email

# components.schemas.91ac10ff_DriveUser.properties.security.properties.has_recovery_email.description
Whether the `Drive User` has a recovery email

# components.schemas.91ac10ff_DriveUser.properties.security.properties.has_valid_phone.description
Whether the `Drive User` has a valid phone number

# components.schemas.91ac10ff_DriveUser.properties.account_id.description
Account identifier of resource `Drive User`

# components.schemas.91ac10ff_DriveUser.properties.product_id.description
Unique identifier of the `product` that is related to the resource `Drive User`

# components.schemas.91ac10ff_DriveUser.properties.status.description
Current access status of the user in the drive.active: User has access to the Drive. deleted_kept: User has been removed but his data remain in the drive. deleted_removed: User has been removed. deleted_transferred: User has been removed and his data has been transferred to another user. deleted_transferring: User has been removed and is being transferred to another user. locked: User has been locked, user can no longer access to the drive. pending: User has not accepted the invitation request.

# components.schemas.91ac10ff_DriveUser.properties.role.description
Administration level of the user.admin: Administrator of the drive, can manage the drive (settings, invitations and users) and the files. external: External user can only access the files given by the others roles. user: Internal user can invite user and manage the files of his private directory and other directories with manage file access.

# components.schemas.91ac10ff_DriveUser.properties.preference.properties.hide.description
Is the drive hidden for the current user

# components.schemas.91ac10ff_DriveUser.properties.preference.properties.default.description
The default drive chosen by the user, if none the first drive in the list should be considered the default. There should only be one default drive.

# components.schemas.91ac10ff_DriveUser.properties.preference.properties.ui.properties.storage_warning_alert.description
Display an alert when storage limit is about to be reached

# components.schemas.91ac10ff_DriveUser.properties.preference.properties.ui.properties.storage_limit_alert.description
Display an alert when storage limit has been reached

# components.schemas.91ac10ff_DriveUser.properties.preference.properties.ui.properties.rag_ocr_promotion.description
Display a promotion message about the RAG OCR if the user has not seen it yet

# components.schemas.91ac10ff_DriveUser.properties.capabilities.properties.has_technical_permission.description
Whether the `Drive User` has the permission to perform technical operations

# components.schemas.91ac10ff_Signature.properties.type.description
The signature type.image: The signature was created from an uploaded image. ink: The signature was drawn using the mouse pointer. text: The signature was generated from a combination of text input and a font.

# components.schemas.91ac10ff_Signature.properties.url.description
The url of the generated signature image

# components.schemas.91ac10ff_Signature.properties.text.description
The text of the signature (only if type = text)

# components.schemas.91ac10ff_Signature.properties.font.description
The font of the signature (only if type = text)

# components.schemas.91ac10ff_Signature.properties.text_color.description
The hexadecimal font color of the signature (only if type = text)

# components.schemas.91ac10ff_Signature.properties.strokes.description
Representation of the signature outline (only if type = ink)

# components.schemas.91ac10ff_UserSignatureStroke.properties.penColor.description
Color of the signature stroke, in hex format

# components.schemas.91ac10ff_UserSignatureStrokePoint.properties.time.description
Point creation integer timestamp in milliseconds

# components.schemas.91ac10ff_AllowStaffAccess.properties.created_at.description
Timestamp `AllowStaffAccess` was created at

# components.schemas.91ac10ff_Userpreference.properties.density.description
Layout density of user interface elements

# components.schemas.91ac10ff_Userpreference.properties.default_drive.description
Drive identifier of default drive to open when none is explicitly chosen in url

# components.schemas.91ac10ff_Userpreference.properties.tutorials.items.description
Identifiers of tutorials that were already played

# components.schemas.91ac10ff_Userpreference.properties.tutorials.description
Identifiers of tutorials that were already played

# components.schemas.91ac10ff_Userpreference.properties.list.properties.storage_largest.properties.property.description
Default property to sort largest items list

# components.schemas.91ac10ff_Userpreference.properties.list.properties.storage_largest.properties.direction.description
Default sort ordering of largest items list

# components.schemas.91ac10ff_Userpreference.properties.list.properties.storage_versions.properties.property.description
Default property to sort list of file versions

# components.schemas.91ac10ff_Userpreference.properties.list.properties.storage_versions.properties.direction.description
Default sort ordering of list of file versions

# components.schemas.91ac10ff_Directory.properties.id.description
Unique identifier of the resource `Directory`

# components.schemas.91ac10ff_Directory.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_Directory.properties.status.description
Current state of Directory. The state can be null meaning that the Directory has no specific state.locked: Directory is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Directory is available. trash_inherited: Directory is currently in trash because a parent directory was trashed. trashed: Directory is currently in trash and specifically trashed by the user. uploading: Directory is currently being uploaded. The Directory is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_Directory.properties.visibility.description
Visibility of Directory, empty string if no specific visibility. Add additional information about Directory to show different icons or more.: Empty visibility mean no special visibility. is_in_team_space_folder: Is a Directory inside a Common Documents directory. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_Directory.properties.created_by.description
The identifier of the user who first uploaded the Directory

# components.schemas.91ac10ff_Directory.properties.created_at.description
Directory creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_Directory.properties.added_at.description
The timestamp (in seconds) at which the Directory has been uploaded for the first time

# components.schemas.91ac10ff_Directory.properties.last_modified_at.description
Directory creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_Directory.properties.deleted_at.description
Timestamp of deleted resource Directory, only visible when the Directory is trashed

# components.schemas.91ac10ff_Directory.properties.deleted_by.description
User identifier of deleted resource Directory, only visible when the Directory is trashed

# components.schemas.91ac10ff_Directory.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_Directory.properties.users.items.description
Array of users identifiers that has access to the Directory

# components.schemas.91ac10ff_Directory.properties.users.description
Array of users identifiers that has access to the Directory

# components.schemas.91ac10ff_Directory.properties.teams.items.description
Array of teams identifiers that has access to the Directory

# components.schemas.91ac10ff_Directory.properties.teams.description
Array of teams identifiers that has access to the Directory

# components.schemas.91ac10ff_Directory.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Directory

# components.schemas.91ac10ff_Directory.properties.activity.description
Activities information about the Directory

# components.schemas.91ac10ff_Directory.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_Directory.properties.capabilities.properties.can_share.description
Right to share Directory or manage access to Directory

# components.schemas.91ac10ff_Directory.properties.capabilities.properties.can_become_dropbox.description
Right to use convert directory into collaborative directory

# components.schemas.91ac10ff_Directory.properties.lock.properties.locked_at.description
When Directory is locked, locked timestamp

# components.schemas.91ac10ff_Directory.properties.lock.properties.unlocked_at.description
When Directory is locked, automatic lock release timestamp

# components.schemas.91ac10ff_Directory.properties.lock.description
When Directory is locked, locked information

# components.schemas.91ac10ff_Directory.properties.color.description
Color of the directory for the user requesting it

# components.schemas.91ac10ff_File.properties.id.description
Unique identifier of the resource `File`

# components.schemas.91ac10ff_File.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_File.properties.status.description
Current state of File. The state can be null meaning that the File has no specific state.locked: File is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: File is available. trash_inherited: File is currently in trash because a parent directory was trashed. trashed: File is currently in trash and specifically trashed by the user. uploading: File is currently being uploaded. The File is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_File.properties.visibility.description
Visibility of File, empty string if no specific visibility. Add additional information about File to show different icons or more.: Empty visibility mean no special visibility. is_in_team_space_folder: Is a File inside a Common Documents directory. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_File.properties.created_by.description
The identifier of the user who first uploaded the File

# components.schemas.91ac10ff_File.properties.created_at.description
File creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_File.properties.added_at.description
The timestamp (in seconds) at which the File has been uploaded for the first time

# components.schemas.91ac10ff_File.properties.last_modified_at.description
File creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_File.properties.deleted_at.description
Timestamp of deleted resource File, only visible when the File is trashed

# components.schemas.91ac10ff_File.properties.deleted_by.description
User identifier of deleted resource File, only visible when the File is trashed

# components.schemas.91ac10ff_File.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_File.properties.users.items.description
Array of users identifiers that has access to the File

# components.schemas.91ac10ff_File.properties.users.description
Array of users identifiers that has access to the File

# components.schemas.91ac10ff_File.properties.teams.items.description
Array of teams identifiers that has access to the File

# components.schemas.91ac10ff_File.properties.teams.description
Array of teams identifiers that has access to the File

# components.schemas.91ac10ff_File.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the File

# components.schemas.91ac10ff_File.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_File.properties.capabilities.properties.can_share.description
Right to share File or manage access to File

# components.schemas.91ac10ff_File.properties.lock.properties.unlocked_at.description
When File is locked, automatic lock release timestamp

# components.schemas.91ac10ff_File.properties.size.description
Size of File <note>The unit of size is defined in Bytes</note>

# components.schemas.91ac10ff_File.properties.has_thumbnail.description
File has thumbnail, if so you can request thumbnail route

# components.schemas.91ac10ff_File.properties.extension_type.description
Generic file types, matching a known set of extensions and/or mime types.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# components.schemas.91ac10ff_File.properties.scan_status.description
Current state of virus scan for File.cannot_be_scanned: This File cannot be scanned. Possibly because the File is too large. clean: This File has been successfully scanned for known viruses. error: An error occurred while scanning the File. infected: This File has been detected as infected by a virus. not_to_be_scanned: This File is not eligible to be scanned. Possibly because the File is empty. pua: This File has been detected as Potentially Unwanted Applications (PUA).to_be_defined: The status for this File has not yet been determined. to_be_scan: This File will be analyzed soon.

# components.schemas.91ac10ff_File.properties.symbolic_link.description
Symlink target path if the file was uploaded as a symlink

# components.schemas.91ac10ff_File.properties.version.properties.total_size.description
Size of the file with all version  (byte unit)

# components.schemas.91ac10ff_File.properties.version.properties.keep_forever.description
True if the current version of this file should be kept forever, otherwise false or empty

# components.schemas.91ac10ff_File.properties.conversion_capabilities.properties.when_downloading.description
Whether the file may be converted upon download

# components.schemas.91ac10ff_File.properties.conversion_capabilities.properties.download_extensions.items.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_File.properties.conversion_capabilities.properties.download_extensions.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_File.properties.conversion_capabilities.properties.when_onlyoffice_opening.description
Whether the file may be converted for live edition with OnlyOffice

# components.schemas.91ac10ff_File.properties.conversion_capabilities.properties.onlyoffice_extension.description
Available extension to which the file may be converted by OnlyOffice, if possible

# components.schemas.91ac10ff_Feedbackresource.properties.message.description
Message, additional information usually given when the result is false

# components.schemas.91ac10ff_ShareLink_35edf22a.properties.reason.description
Optional reason given when the Share-link was blocked

# components.schemas.91ac10ff_DriveSettings.properties.ai_scan.properties.has_approved.description
Has approved the file scan for IA purpose

# components.schemas.91ac10ff_DriveSettings.properties.ai_scan.properties.has_approved_ai_categories.description
Has approved automatic `Categories` on `Files`

# components.schemas.91ac10ff_DriveSettings.properties.trash.properties.max_duration.description
Number of days the files are kept in trash. <note>Unit is in days</note>

# components.schemas.91ac10ff_DriveSettings.properties.office.properties.presentation.description
Default current application for presentation document

# components.schemas.91ac10ff_DriveSettings.properties.office.properties.form.description
Default current application for form document

# components.schemas.91ac10ff_DriveSettings.properties.office.properties.spreadsheet.description
Default current application for spreadsheet document

# components.schemas.91ac10ff_DriveSettings.properties.office.properties.text.description
Default current application for text document

# components.schemas.91ac10ff_DriveSettings.properties.versioning.properties.max_numbers.description
Number of versions that can be kept if active

# components.schemas.91ac10ff_DriveSettings.properties.versioning.properties.max_days.description
Maximum number of days versions are kept

# components.schemas.91ac10ff_DriveSettings.properties.max_keep_deleted_user.description
Max time the files of an user deleted is kept

# components.schemas.91ac10ff_DriveSettings.properties.files.properties.private.properties.size_threshold.description
Size quota for private directory. <note>Size in bytes, value is null if no limit has been set on private folders.</note>

# components.schemas.91ac10ff_DriveSettings.properties.report.properties.storage_report.properties.frequency.description
Report frequency.monthly: Sent every month. never: Never sent. semi-monthly: Sent every two week. weekly: Sent every week.

# components.schemas.91ac10ff_PublicImage.properties.id.description
Unique identifier of the resource `PublicImage`

# components.schemas.91ac10ff_Team_d284d7a7.properties.id.description
Unique identifier of the resource `Team`

# components.schemas.91ac10ff_Team_d284d7a7.properties.color_id.description
Unique identifier of the `color` of the resource `Team`

# components.schemas.91ac10ff_Team_d284d7a7.properties.logo.description
Logo of the team <note>The default value is multiple-users</note>

# components.schemas.91ac10ff_Team_d284d7a7.properties.users.items.description
All users ids in the team <note>Not provided for All Drive teams (specific team)</note>

# components.schemas.91ac10ff_Team_d284d7a7.properties.users.description
All users ids in the team <note>Not provided for All Drive teams (specific team)</note>

# components.schemas.91ac10ff_Team_d284d7a7.properties.users_count.description
Count all users in the teams <note>Not provided for All Drive teams (specific team)</note>

# components.schemas.91ac10ff_DriveUserInvitation.properties.id.description
Unique identifier of the resource `Drive User Invitation`

# components.schemas.91ac10ff_DriveUserInvitation.properties.key.description
Random key used to uniquely identify the `Invitation`

# components.schemas.91ac10ff_DriveUserInvitation.properties.invited_by.description
Identifier of `User` that sent the invitation

# components.schemas.91ac10ff_DriveUserInvitation.properties.is_valid.description
Whether the `Invitation` is still valid or not

# components.schemas.91ac10ff_DriveUserInvitation.properties.role.description
Role that will be assigned to invited `User`

# components.schemas.91ac10ff_FileV3.properties.id.description
Unique identifier of the resource `File V3`

# components.schemas.91ac10ff_FileV3.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_FileV3.properties.status.description
Current state of File V3. The state can be null meaning that the File V3 has no specific state.locked: File V3 is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: File V3 is available. trash_inherited: File V3 is currently in trash because a parent directory was trashed. trashed: File V3 is currently in trash and specifically trashed by the user. uploading: File V3 is currently being uploaded. The File V3 is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_FileV3.properties.visibility.description
Visibility of File V3, empty string if no specific visibility. Add additional information about File V3 to show different icons or more.: Empty visibility mean no special visibility. is_in_private_space: Is a File V3 inside the private directory of the user. is_in_shared_space: Is a File V3 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_in_team_space_folder: Is a File V3 inside a Common Documents directory. is_private_space: Is the private directory of the user. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_FileV3.properties.created_by.description
The identifier of the user who first uploaded the File V3

# components.schemas.91ac10ff_FileV3.properties.created_at.description
File V3 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_FileV3.properties.added_at.description
The timestamp (in seconds) at which the File V3 has been uploaded for the first time

# components.schemas.91ac10ff_FileV3.properties.last_modified_at.description
File V3 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_FileV3.properties.last_modified_by.description
Id of the user who last modified the File V3

# components.schemas.91ac10ff_FileV3.properties.revised_at.description
The last time the content of the File V3 was revised

# components.schemas.91ac10ff_FileV3.properties.deleted_at.description
Timestamp of deleted resource File V3, only visible when the File V3 is trashed

# components.schemas.91ac10ff_FileV3.properties.deleted_by.description
User identifier of deleted resource File V3, only visible when the File V3 is trashed

# components.schemas.91ac10ff_FileV3.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_FileV3.properties.users.items.description
Array of users identifiers that has access to the File V3

# components.schemas.91ac10ff_FileV3.properties.users.description
Array of users identifiers that has access to the File V3

# components.schemas.91ac10ff_FileV3.properties.teams.items.description
Array of teams identifiers that has access to the File V3

# components.schemas.91ac10ff_FileV3.properties.teams.description
Array of teams identifiers that has access to the File V3

# components.schemas.91ac10ff_FileV3.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the File V3

# components.schemas.91ac10ff_FileV3.properties.activity.description
Activities information about the File V3

# components.schemas.91ac10ff_FileV3.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_FileV3.properties.capabilities.properties.can_share.description
Right to share File V3 or manage access to File V3

# components.schemas.91ac10ff_FileV3.properties.lock.properties.locked_at.description
When File V3 is locked, locked timestamp

# components.schemas.91ac10ff_FileV3.properties.lock.properties.unlocked_at.description
When File V3 is locked, automatic lock release timestamp

# components.schemas.91ac10ff_FileV3.properties.lock.properties.description.description
List of applications.365: The 365 application. external_import: The external_import application. internal_copy: The internal_copy application. internal_import: The internal_import application. onlyoffice: The onlyoffice application. webdav: The webdav application.

# components.schemas.91ac10ff_FileV3.properties.lock.description
When File V3 is locked, locked information

# components.schemas.91ac10ff_FileV3.properties.size.description
Size of File V3 <note>The unit of size is defined in Bytes</note>

# components.schemas.91ac10ff_FileV3.properties.extension_type.description
Generic file types, matching a known set of extensions and/or mime types.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# components.schemas.91ac10ff_FileV3.properties.symbolic_link.description
Symlink target path if the file was uploaded as a symlink

# components.schemas.91ac10ff_FileV3.properties.scan_status.description
Current state of virus scan for File V3.cannot_be_scanned: This File V3 cannot be scanned. Possibly because the File V3 is too large. clean: This File V3 has been successfully scanned for known viruses. error: An error occurred while scanning the File V3. infected: This File V3 has been detected as infected by a virus. not_to_be_scanned: This File V3 is not eligible to be scanned. Possibly because the File V3 is empty. pua: This File V3 has been detected as Potentially Unwanted Applications (PUA).to_be_defined: The status for this File V3 has not yet been determined. to_be_scan: This File V3 will be analyzed soon.

# components.schemas.91ac10ff_FileV3.properties.supported_by.description
List of applications.365: The 365 application. drawio: The drawio application. kmail: The kmail application. onlyoffice: The onlyoffice application. thumbnail: Thumbnail is preview and thumbnail.

# components.schemas.91ac10ff_FileV3.properties.version.properties.total_size.description
Size of the file with all version  (byte unit)

# components.schemas.91ac10ff_FileV3.properties.version.properties.keep_forever.description
True if the current version of this file should be kept forever, otherwise false or empty

# components.schemas.91ac10ff_FileV3.properties.conversion_capabilities.properties.when_downloading.description
Whether the file may be converted upon download

# components.schemas.91ac10ff_FileV3.properties.conversion_capabilities.properties.download_extensions.items.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_FileV3.properties.conversion_capabilities.properties.download_extensions.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_FileV3.properties.conversion_capabilities.properties.when_onlyoffice_opening.description
Whether the file may be converted for live edition with OnlyOffice

# components.schemas.91ac10ff_FileV3.properties.conversion_capabilities.properties.onlyoffice_extension.description
Available extension to which the file may be converted by OnlyOffice, if possible

# components.schemas.91ac10ff_DriveLimits.properties.files_by_folders.description
Number of files/folders in the same folder

# components.schemas.91ac10ff_DriveLimits.properties.versioning_days.description
Number of days a version of a file is conserved

# components.schemas.91ac10ff_DriveLimits.properties.empty_trash_days.description
Number of days a file is conserved when trashed

# components.schemas.91ac10ff_DriveLimits.properties.concurrent_external_imports.description
Maximum number of external imports which may run at the same time

# components.schemas.91ac10ff_DriveDefaultLimits.properties.files_by_folders.description
Number of files/folders in the same folder

# components.schemas.91ac10ff_DriveDefaultLimits.properties.empty_trash_days.description
Number of days a file is conserved when trashed

# components.schemas.91ac10ff_DriveDefaultLimits.properties.versioning_days.description
Number of days a version of a file is conserved

# components.schemas.91ac10ff_DriveDefaultLimits.properties.bandwidth.description
Bandwidth authorize for a user in 24 hours

# components.schemas.91ac10ff_DriveDefaultLimits.properties.min_size_for_hotcache.description
Minimum size of a file to be cached on kCache before moving to a "cold" storage

# components.schemas.91ac10ff_DriveDefaultLimits.properties.max_size_for_hotcache.description
Maximum size of a file to be cached on kCache before moving to a "cold" storage

# components.schemas.91ac10ff_DriveDefaultLimits.properties.concurrent_external_imports.description
Maximum number of external imports which may run at the same time

# components.schemas.91ac10ff_DriveDefaultLimits.properties.stats_days.description
Maximum number of days, in past, statistics can be seen - 0 for unlimited

# components.schemas.91ac10ff_ActivityFile.properties.id.description
Unique identifier of the resource `Activity File`

# components.schemas.91ac10ff_ActivityFile.properties.created_at.description
Timestamp `Activity File` was created at

# components.schemas.91ac10ff_ActivityFile.properties.new_path.description
Current path of the activity file/directory

# components.schemas.91ac10ff_ActivityFile.properties.old_path.description
Previous path of the activity file/directory

# components.schemas.91ac10ff_ActivityFile.properties.user_id.description
User identifier of the action, null if the user was not logged

# components.schemas.91ac10ff_ActivityFile.properties.source.description
Information about where the Activity was generated

# components.schemas.91ac10ff_ActivityFile.properties.file.description
Associated File or Directory, null is element was deleted

# components.schemas.91ac10ff_ActivityReport.properties.status.description
Report status:
in_progress: Report generation still in progress
done: Report can be downloaded/exported
failed: Report generation failed

# components.schemas.91ac10ff_ActivityReport.properties.created_at.description
Timestamp `Activity Report` was created at

# components.schemas.91ac10ff_ActivityReport.properties.updated_at.description
Timestamp `Activity Report` was updated at

# components.schemas.91ac10ff_ActivityReport.properties.filters.properties.actions.items.description
Logged interaction type of activities on the drive or file.acl_insert: Technical: when a new group access to a file/directory is create. acl_main_users_insert: Logged when the main kDrive team access to a file/directory is created. acl_main_users_remove: Logged when the main kDrive team to a file/directory is removed. acl_main_users_update: Logged when the main kDrive team to a file/directory is modified. acl_remove: Technical: when a group access to a file/directory is removed. acl_team_insert: Logged when a team access to a file/directory is created. acl_team_remove: Logged when a team access to a file/directory is removed. acl_team_update: Logged when a team access to a file/directory is modified. acl_update: Technical: when a group access to a file/directory is modified. acl_user_insert: Logged when an user/admin access to a file/directory is created. acl_user_remove: Logged when an user/admin access to a file/directory is removed. acl_user_update: Logged when an user/admin access to a file/directory is modified. category_create: Logged when a new category is added. category_delete: Logged when a category is deleted. category_update: Logged when a category is renamed. collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. exchange_pro_create: Technical: no used. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. file_update_mime_type: Logged when a file mime_type is updated. maintenance_added: Logged when a maintenance start. maintenance_removed: Logged when a maintenance ends. rewind_ended: Logged when the user ended a rewind. rewind_started: Logged when the user started a rewind. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified. trash_empty: Logged when the user empties the trash. trash_empty_auto: Logged when the trash empties old files automatically. update_trash_settings: Logged when the user changes trash the settings. user_connected: Logged when an user is connected to the drive. user_create: Logged when an user/admin is added to the drive. user_delete: Logged when an user/admin has been removed of the drive. user_restore: Logged when an user/admin has been restored of the drive. user_update: Logged when an user/admin information has changed.

# components.schemas.91ac10ff_ActivityReport.properties.filters.properties.actions.description
Logged interaction type of activities on the drive or file.acl_insert: Technical: when a new group access to a file/directory is create. acl_main_users_insert: Logged when the main kDrive team access to a file/directory is created. acl_main_users_remove: Logged when the main kDrive team to a file/directory is removed. acl_main_users_update: Logged when the main kDrive team to a file/directory is modified. acl_remove: Technical: when a group access to a file/directory is removed. acl_team_insert: Logged when a team access to a file/directory is created. acl_team_remove: Logged when a team access to a file/directory is removed. acl_team_update: Logged when a team access to a file/directory is modified. acl_update: Technical: when a group access to a file/directory is modified. acl_user_insert: Logged when an user/admin access to a file/directory is created. acl_user_remove: Logged when an user/admin access to a file/directory is removed. acl_user_update: Logged when an user/admin access to a file/directory is modified. category_create: Logged when a new category is added. category_delete: Logged when a category is deleted. category_update: Logged when a category is renamed. collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. exchange_pro_create: Technical: no used. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. file_update_mime_type: Logged when a file mime_type is updated. maintenance_added: Logged when a maintenance start. maintenance_removed: Logged when a maintenance ends. rewind_ended: Logged when the user ended a rewind. rewind_started: Logged when the user started a rewind. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified. trash_empty: Logged when the user empties the trash. trash_empty_auto: Logged when the trash empties old files automatically. update_trash_settings: Logged when the user changes trash the settings. user_connected: Logged when an user is connected to the drive. user_create: Logged when an user/admin is added to the drive. user_delete: Logged when an user/admin has been removed of the drive. user_restore: Logged when an user/admin has been restored of the drive. user_update: Logged when an user/admin information has changed.

# components.schemas.91ac10ff_StatisticSharelink.properties.right.description
Rights required to view the share link.inherit: Share link is accessible only by users of the drive. password: Share link is public but protected by a password. public: Share link is public, no restriction set.

# components.schemas.91ac10ff_StatisticSharelink.properties.created_by.description
Unique identifier of the creator of the resource `Statistic Share link`

# components.schemas.91ac10ff_StatisticSharelink.properties.created_at.description
Timestamp `Statistic Share link` was created at

# components.schemas.91ac10ff_StatisticSharelink.properties.updated_at.description
Timestamp `Statistic Share link` was updated at

# components.schemas.91ac10ff_StatisticSharelink.properties.capabilities.properties.can_request_access.description
Does share link allow user to request access to folder

# components.schemas.91ac10ff_StatisticSharelink.properties.file.description
File information if the user has right to see the file.

# components.schemas.91ac10ff_Thirdpartydriveslist.properties.access_token_id.description
The access token identifier built for future requests for the suitable drives

# components.schemas.91ac10ff_Thirdpartydriveslist.description
List of third party drives eligible to perform an external import

# components.schemas.91ac10ff_Thirdpartydrive.description
A third party drive which may be eligible for external import

# components.schemas.91ac10ff_ExternalImportFile.properties.status.description
External file import status.error: External file import failed; additional information are available in the message field. finished: External file was imported successfully.

# components.schemas.91ac10ff_UUIDFeedbackresource.properties.message.description
Message, additional information usually given when the result is false

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.id.description
Unique identifier of the resource `Deleted Generic File V2`

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.path.description
Full path of the Deleted Generic File V2

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.visibility.description
Visibility of Deleted Generic File V2, empty string if no specific visibility. Add additional information about Deleted Generic File V2 to show different icons or more.: Empty visibility mean no special visibility. is_in_private_space: Is a Deleted Generic File V2 inside the private directory of the user. is_in_shared_space: Is a Deleted Generic File V2 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_in_team_space_folder: Is a Deleted Generic File V2 inside a Common Documents directory. is_private_space: Is the private directory of the user. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.depth.description
Current path depth of Deleted Generic File V2

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.created_by.description
The identifier of the user who first uploaded the Deleted Generic File V2

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.deleted_at.description
Timestamp of deleted resource Deleted Generic File V2, only visible when the Deleted Generic File V2 is trashed

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.deleted_by.description
User identifier of deleted resource Deleted Generic File V2, only visible when the Deleted Generic File V2 is trashed

# components.schemas.91ac10ff_DeletedGenericFileV2.properties.extension_type.description
File type, properties is not returned for directory type

# components.schemas.91ac10ff_SanitizedActivity.properties.action.description
Action to do in rewind situation.archive: File needs to be archived in a specific directory. archive_in_trash: File needs to be archived in trash root. exclude: File is excluded. No actions will be performed. file_deleted: File does not exist. move: File needs to be moved. rename: File needs to be renamed. restore: File needs to be restored from trash. trash: File needs to be trashed. update: File content need to be updated. version_deleted: File content does not exist.

# components.schemas.91ac10ff_SanitizedActivity.properties.state.description
State one action in the rewind process.not_executed: Action was not executed yet. not_handled: Action cannot be rewound. on_conflict: Action lead to a conflict with another file/directory, this item was moved to a specific directory. on_error: Action lead to a fatal error, for instance the targeted version of a file was unable to be restored. success: Action was executed correctly.

# components.schemas.91ac10ff_Rewind.properties.status.description
Rewind status.canceled: Rewind was canceled by the user and deleted. done: Rewind completed successfully. drive_not_ready: Rewind cannot start because the drive was not ready (uploads or actions in progress).expired: Rewind has expired and deleted. failed: Rewind completed with errors. in_progress: Rewind is currently in progress. new: Rewind did not start. sanitizing: Rewind find the activity to sanitize. waiting_approval: Rewind waiting user approval to continue.

# components.schemas.91ac10ff_Rewind.properties.mode.description
Rewind type.directory: Rewind only a directory. drive: Rewind all the drive. user: Rewind a user's private folder.

# components.schemas.91ac10ff_Rewind.properties.archiving.description
Rewind archive mode, all created files between now and the rewind date will be set to trash or to an archive depending on the mode selected.all: Keep in an archive folder the current or trashed files. current: Keep in an archive folder the current files. none: Don't build an archive, trash all created files.

# components.schemas.91ac10ff_Rewind.properties.directory_id.description
The targeted directory of the rewind <note>Filled only in directory and user mode</note>

# components.schemas.91ac10ff_Rewind.properties.directory_name.description
The name of the directory selected when the directory mode is selected

# components.schemas.91ac10ff_Rewind.properties.user_id.description
The targeted user of the rewind <note>Filled only in user mode</note>

# components.schemas.91ac10ff_Rewind.properties.finished_at.description
when the rewind is executed the finished process time is save here

# components.schemas.91ac10ff_Rewind.properties.rewind_name.description
The name of the directory choose during approval step

# components.schemas.91ac10ff_Rewind.properties.sanitizer.description
Sanitizer resume, returned only when the rewind has done the sanitizing process

# components.schemas.91ac10ff_Rewind.properties.summary.description
Rewind resume, returned only when the rewind is finished

# components.schemas.91ac10ff_SanitizedFileAccessRequest.properties.user_id.description
ID of the user requesting access to the file

# components.schemas.91ac10ff_SanitizedFileAccessRequest.properties.validated_by.description
ID of the user whom validate the request

# components.schemas.91ac10ff_SanitizedFileAccessRequest.properties.file_id.description
ID of the file the user request access to

# components.schemas.91ac10ff_FileVersionV2.properties.id.description
Unique identifier of the resource `File Version V2`

# components.schemas.91ac10ff_FileVersionV2.properties.keep_forever.description
Keep the resource `File Version V2` forever, otherwise will be delete in 120 days

# components.schemas.91ac10ff_FileVersionV2.properties.mime_type.description
Mime type of the resource `File Version V2`

# components.schemas.91ac10ff_FileVersionV2.properties.converted_type.description
Generic file types, matching a known set of extensions and/or mime types.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# components.schemas.91ac10ff_FileVersionV2.properties.created_at.description
Timestamp `File Version V2` was created at

# components.schemas.91ac10ff_FileVersionV2.properties.updated_at.description
Timestamp `File Version V2` was updated at

# components.schemas.91ac10ff_FileVersionV2.properties.last_modified_at.description
The last modified date of the file version, null if unknown

# components.schemas.91ac10ff_Feedbackaccessresource.properties.id.description
The email,team or user identifier filled in the parameters

# components.schemas.91ac10ff_Feedbackaccessresource.properties.access.description
The invitation send, null if access was not found

# components.schemas.91ac10ff_Feedbackaccessresource.properties.message.description
Additional message about why email fail to be sent

# components.schemas.91ac10ff_ExternInvitationFileAccess.properties.id.description
Extern Invitation File Access Identifier, can be team identifier, user identifier, invitation identifier

# components.schemas.91ac10ff_TeamFileAccess.properties.id.description
Team File Access Identifier, can be team identifier, user identifier, invitation identifier

# components.schemas.91ac10ff_Userfileaccess.properties.id.description
User file access Identifier, can be team identifier, user identifier, invitation identifier

# components.schemas.91ac10ff_Userandteamsaccessonparentfile.properties.mismatch.description
Whether this file inherits the same or higher access permissions as its parent, with no downgrades.

# components.schemas.91ac10ff_Userandteamsaccessonparentfile.properties.users.description
All users that have access to the parent file

# components.schemas.91ac10ff_Userandteamsaccessonparentfile.properties.teams.description
All teams that have access to the parent file

# components.schemas.91ac10ff_Checkchangeaccessfeedbackresource.properties.current_right.description
The current user right for the File/Directory

# components.schemas.91ac10ff_Checkchangeaccessfeedbackresource.properties.need_change.description
If the right asked need to be applied to this user, return false if the right is the same level or not applicable.
Note: A user with limited file access don't need to change his right

# components.schemas.91ac10ff_Checkchangeaccessfeedbackresource.properties.message.description
Additional information about why the right need to be applied or not :
user_right_need_change: If the right need to be changed
user_right_is_same_level: If the right is the same level
user_not_connected_to_drive: If the user did not connected to the drive yet
error: If the right cannot be changed for other reason

# components.schemas.91ac10ff_Feedbackaccesspendinginvitationresource.title
Feedback access pending invitation resource

# components.schemas.91ac10ff_Feedbackaccesspendinginvitationresource.properties.invitation_id.description
The pending invitation of the file, if any

# components.schemas.91ac10ff_Feedbackaccesspendinginvitationresource.properties.drive_invitation_id.description
The pending invitation of the drive if any

# components.schemas.91ac10ff_Feedbackaccesspendinginvitationresource.properties.has_invitation.description
If there is at least a file or drive pending invitation on the drive

# components.schemas.91ac10ff_Comment.properties.id.description
Unique identifier of the resource `Comment`

# components.schemas.91ac10ff_Comment.properties.parent_id.description
Comment parent identifier. If present, this comment is a response of another comment

# components.schemas.91ac10ff_Comment.properties.is_resolved.description
If a comment is set as resolved, solved.

# components.schemas.91ac10ff_Comment.properties.liked.description
Whether current user has liked the comment

# components.schemas.91ac10ff_GenericFile.properties.id.description
Unique identifier of the resource `Generic File`

# components.schemas.91ac10ff_GenericFile.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_GenericFile.properties.status.description
Current state of Generic File. The state can be null meaning that the Generic File has no specific state.locked: Generic File is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Generic File is available. trash_inherited: Generic File is currently in trash because a parent directory was trashed. trashed: Generic File is currently in trash and specifically trashed by the user. uploading: Generic File is currently being uploaded. The Generic File is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_GenericFile.properties.visibility.description
Visibility of Generic File, empty string if no specific visibility. Add additional information about Generic File to show different icons or more.: Empty visibility mean no special visibility. is_in_team_space_folder: Is a Generic File inside a Common Documents directory. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_GenericFile.properties.created_by.description
The identifier of the user who first uploaded the Generic File

# components.schemas.91ac10ff_GenericFile.properties.created_at.description
Generic File creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_GenericFile.properties.added_at.description
The timestamp (in seconds) at which the Generic File has been uploaded for the first time

# components.schemas.91ac10ff_GenericFile.properties.last_modified_at.description
Generic File creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_GenericFile.properties.deleted_at.description
Timestamp of deleted resource Generic File, only visible when the Generic File is trashed

# components.schemas.91ac10ff_GenericFile.properties.deleted_by.description
User identifier of deleted resource Generic File, only visible when the Generic File is trashed

# components.schemas.91ac10ff_GenericFile.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_GenericFile.properties.users.items.description
Array of users identifiers that has access to the Generic File

# components.schemas.91ac10ff_GenericFile.properties.users.description
Array of users identifiers that has access to the Generic File

# components.schemas.91ac10ff_GenericFile.properties.teams.items.description
Array of teams identifiers that has access to the Generic File

# components.schemas.91ac10ff_GenericFile.properties.teams.description
Array of teams identifiers that has access to the Generic File

# components.schemas.91ac10ff_GenericFile.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Generic File

# components.schemas.91ac10ff_GenericFile.properties.activity.description
Activities information about the Generic File

# components.schemas.91ac10ff_GenericFile.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_GenericFile.properties.capabilities.properties.can_share.description
Right to share Generic File or manage access to Generic File

# components.schemas.91ac10ff_GenericFile.properties.lock.properties.locked_at.description
When Generic File is locked, locked timestamp

# components.schemas.91ac10ff_GenericFile.properties.lock.properties.unlocked_at.description
When Generic File is locked, automatic lock release timestamp

# components.schemas.91ac10ff_GenericFile.properties.lock.properties.description.description
When Generic File is locked, locked reason

# components.schemas.91ac10ff_GenericFile.properties.lock.properties.token.description
When Generic File is locked, locked token

# components.schemas.91ac10ff_GenericFile.properties.lock.description
When Generic File is locked, locked information

# components.schemas.91ac10ff_ActivitiesforFile.properties.result.description
If the user has the write to access the file

# components.schemas.91ac10ff_ActivitiesforFile.properties.file.description
Associated File or Directory, null is element was not found

# components.schemas.91ac10ff_ActivityFileV3.properties.id.description
Unique identifier of the resource `Activity File V3`

# components.schemas.91ac10ff_ActivityFileV3.properties.created_at.description
Timestamp `Activity File V3` was created at

# components.schemas.91ac10ff_ActivityFileV3.properties.new_path.description
Current path of the activity file/directory

# components.schemas.91ac10ff_ActivityFileV3.properties.old_path.description
Previous path of the activity file/directory

# components.schemas.91ac10ff_ActivityFileV3.properties.user_id.description
User identifier of the action, null if the user was not logged

# components.schemas.91ac10ff_ActivityFileV3.properties.source.description
Information about where the Activity was generated

# components.schemas.91ac10ff_ActivityFileV3.properties.file.description
Associated File or Directory, null is element was deleted

# components.schemas.91ac10ff_UUIDResource.properties.uuid.description
Universally unique identifier of the resource `UUID Resource`

# components.schemas.91ac10ff_CursorListingsV2.properties.has_more.description
Whether there currently is more data to be found in the Cursor and should perform another request to retrieve said data

# components.schemas.91ac10ff_CursorListingsV2.properties.actions.description
List of `actions` that were performed since last cursor call

# components.schemas.91ac10ff_ActivityV2.properties.size.description
Size of Activity V2 <note>The unit of size is defined in Bytes</note>

# components.schemas.91ac10ff_ActivityV2.properties.last_modified_at.description
Activity V2 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_ActivityV2.properties.destination.description
Destination of Directory/File in case of move or rename action

# components.schemas.91ac10ff_ActivityV2.properties.created_at.description
Activity V2 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_ActivityV2.properties.symbolic_link.description
Symlink target path if the related file was uploaded as a symlink

# components.schemas.91ac10ff_CursorV2.properties.source_id.description
ID of the directory the cursor was created in

# components.schemas.91ac10ff_CursorV2.properties.activity_id.description
ID of the last activity seen by the cursor

# components.schemas.91ac10ff_CursorV2.properties.recursive.description
Whether the cursor also reads children directories

# components.schemas.91ac10ff_Upload.properties.expected_chunks.description
The expected number of chunks to be received

# components.schemas.91ac10ff_Uploadsegment.properties.number.description
Index of the chunk to compute the final object correctly

# components.schemas.91ac10ff_Uploadsegment.properties.status.description
The chunk status during the upload.error: Something was wrong chunk was not correctly received, retried to send the same chunk. ok: Chunk has been received. uploading: Chunks still uploading.

# components.schemas.91ac10ff_Uploadsegment.properties.created_at.description
Timestamp `Upload segment` was created at

# components.schemas.91ac10ff_UploadSessionFeedback.properties.file_id.description
Directory destination identifier requested on upload

# components.schemas.91ac10ff_UploadSessionFeedback.properties.directory_id.description
Directory destination identifier requested on upload

# components.schemas.91ac10ff_UploadSessionFeedback.properties.directory_path.description
Directory destination path requested on upload

# components.schemas.91ac10ff_UploadSessionFeedback.properties.message.description
The error code returned, null if no error happens.conflict_error: Conflict detected. In the upload another conflict mode can be used to handle it. file_already_exists_error: Action impossible. The file already exist. forbidden_error: Triggered when user does not have the file permission. lock_error: Action impossible. There is a lock on the file/directory. quota_exceeded_error: Triggered when the quota storage of the drive is reached. upload_by_another_user_not_terminated_error: Another user upload the same file, the upload should be handle with another conflict mode or the user should wait the current upload. upload_error: Triggered when the upload did not finish, you should retry the upload. upload_failed_error: Something is wrong, the received file did not match with the expected parameters (hash, size...), the upload should be restarted. upload_not_terminated_error: Triggered when the upload did not receive all the expected chunks or the file is currently uploading.

# components.schemas.91ac10ff_Closinguploadsession.properties.message.description
Additional message about the closed upload session

# components.schemas.91ac10ff_PublicsharedFile.properties.id.description
Unique identifier of the resource `Public shared File`

# components.schemas.91ac10ff_PublicsharedFile.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_PublicsharedFile.properties.status.description
Current state of Public shared File. The state can be null meaning that the Public shared File has no specific state.locked: Public shared File is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Public shared File is available. trash_inherited: Public shared File is currently in trash because a parent directory was trashed. trashed: Public shared File is currently in trash and specifically trashed by the user. uploading: Public shared File is currently being uploaded. The Public shared File is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_PublicsharedFile.properties.visibility.description
Visibility of Public shared File, empty string if no specific visibility. Add additional information about Public shared File to show different icons or more.: Empty visibility mean no special visibility. is_in_team_space_folder: Is a Public shared File inside a Common Documents directory. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_PublicsharedFile.properties.depth.description
Current path depth of Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.created_by.description
The identifier of the user who first uploaded the Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.created_at.description
Public shared File creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_PublicsharedFile.properties.added_at.description
The timestamp (in seconds) at which the Public shared File has been uploaded for the first time

# components.schemas.91ac10ff_PublicsharedFile.properties.last_modified_at.description
Public shared File creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_PublicsharedFile.properties.deleted_at.description
Timestamp of deleted resource Public shared File, only visible when the Public shared File is trashed

# components.schemas.91ac10ff_PublicsharedFile.properties.deleted_by.description
User identifier of deleted resource Public shared File, only visible when the Public shared File is trashed

# components.schemas.91ac10ff_PublicsharedFile.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_PublicsharedFile.properties.users.items.description
Array of users identifiers that has access to the Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.users.description
Array of users identifiers that has access to the Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.teams.items.description
Array of teams identifiers that has access to the Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.teams.description
Array of teams identifiers that has access to the Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.is_favorite.description
Is Public shared File pinned as favorite

# components.schemas.91ac10ff_PublicsharedFile.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.activity.description
Activities information about the Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_PublicsharedFile.properties.capabilities.properties.can_show.description
Right to see Public shared File information

# components.schemas.91ac10ff_PublicsharedFile.properties.capabilities.properties.can_read.description
Right to read Public shared File content

# components.schemas.91ac10ff_PublicsharedFile.properties.capabilities.properties.can_share.description
Right to share Public shared File or manage access to Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.capabilities.properties.can_leave.description
Right to leave shared Public shared File

# components.schemas.91ac10ff_PublicsharedFile.properties.lock.properties.locked_at.description
When Public shared File is locked, locked timestamp

# components.schemas.91ac10ff_PublicsharedFile.properties.lock.properties.unlocked_at.description
When Public shared File is locked, automatic lock release timestamp

# components.schemas.91ac10ff_PublicsharedFile.properties.lock.properties.description.description
When Public shared File is locked, locked reason

# components.schemas.91ac10ff_PublicsharedFile.properties.lock.properties.token.description
When Public shared File is locked, locked token

# components.schemas.91ac10ff_PublicsharedFile.properties.lock.description
When Public shared File is locked, locked information

# components.schemas.91ac10ff_PublicsharedFile.properties.size.description
Size of Public shared File <note>The unit of size is defined in Bytes</note>

# components.schemas.91ac10ff_PublicsharedFile.properties.has_thumbnail.description
File has thumbnail, if so you can request thumbnail route

# components.schemas.91ac10ff_PublicsharedFile.properties.extension_type.description
Generic file types, matching a known set of extensions and/or mime types.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# components.schemas.91ac10ff_PublicsharedFile.properties.scan_status.description
Current state of virus scan for Public shared File.cannot_be_scanned: This Public shared File cannot be scanned. Possibly because the Public shared File is too large. clean: This Public shared File has been successfully scanned for known viruses. error: An error occurred while scanning the Public shared File. infected: This Public shared File has been detected as infected by a virus. not_to_be_scanned: This Public shared File is not eligible to be scanned. Possibly because the Public shared File is empty. pua: This Public shared File has been detected as Potentially Unwanted Applications (PUA).to_be_defined: The status for this Public shared File has not yet been determined. to_be_scan: This Public shared File will be analyzed soon.

# components.schemas.91ac10ff_PublicsharedFile.properties.symbolic_link.description
Symlink target path if the file was uploaded as a symlink

# components.schemas.91ac10ff_PublicsharedFile.properties.version.properties.total_size.description
Size of the file with all version  (byte unit)

# components.schemas.91ac10ff_PublicsharedFile.properties.version.properties.keep_forever.description
True if the current version of this file should be kept forever, otherwise false or empty

# components.schemas.91ac10ff_PublicsharedFile.properties.conversion_capabilities.properties.when_downloading.description
Whether the file may be converted upon download

# components.schemas.91ac10ff_PublicsharedFile.properties.conversion_capabilities.properties.download_extensions.items.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_PublicsharedFile.properties.conversion_capabilities.properties.download_extensions.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_PublicsharedFile.properties.conversion_capabilities.properties.when_onlyoffice_opening.description
Whether the file may be converted for live edition with OnlyOffice

# components.schemas.91ac10ff_PublicsharedFile.properties.conversion_capabilities.properties.onlyoffice_extension.description
Available extension to which the file may be converted by OnlyOffice, if possible

# components.schemas.91ac10ff_PublicsharedDirectory.properties.id.description
Unique identifier of the resource `Public shared Directory`

# components.schemas.91ac10ff_PublicsharedDirectory.properties.path.description
Full path of the Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_PublicsharedDirectory.properties.status.description
Current state of Public shared Directory. The state can be null meaning that the Public shared Directory has no specific state.locked: Public shared Directory is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Public shared Directory is available. trash_inherited: Public shared Directory is currently in trash because a parent directory was trashed. trashed: Public shared Directory is currently in trash and specifically trashed by the user. uploading: Public shared Directory is currently being uploaded. The Public shared Directory is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_PublicsharedDirectory.properties.visibility.description
Visibility of Public shared Directory, empty string if no specific visibility. Add additional information about Public shared Directory to show different icons or more.: Empty visibility mean no special visibility. is_in_team_space_folder: Is a Public shared Directory inside a Common Documents directory. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_PublicsharedDirectory.properties.depth.description
Current path depth of Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.created_by.description
The identifier of the user who first uploaded the Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.created_at.description
Public shared Directory creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_PublicsharedDirectory.properties.added_at.description
The timestamp (in seconds) at which the Public shared Directory has been uploaded for the first time

# components.schemas.91ac10ff_PublicsharedDirectory.properties.last_modified_at.description
Public shared Directory creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_PublicsharedDirectory.properties.deleted_at.description
Timestamp of deleted resource Public shared Directory, only visible when the Public shared Directory is trashed

# components.schemas.91ac10ff_PublicsharedDirectory.properties.deleted_by.description
User identifier of deleted resource Public shared Directory, only visible when the Public shared Directory is trashed

# components.schemas.91ac10ff_PublicsharedDirectory.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_PublicsharedDirectory.properties.users.items.description
Array of users identifiers that has access to the Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.users.description
Array of users identifiers that has access to the Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.teams.items.description
Array of teams identifiers that has access to the Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.teams.description
Array of teams identifiers that has access to the Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.is_favorite.description
Is Public shared Directory pinned as favorite

# components.schemas.91ac10ff_PublicsharedDirectory.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.activity.description
Activities information about the Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_PublicsharedDirectory.properties.capabilities.properties.can_show.description
Right to see Public shared Directory information

# components.schemas.91ac10ff_PublicsharedDirectory.properties.capabilities.properties.can_read.description
Right to read Public shared Directory content

# components.schemas.91ac10ff_PublicsharedDirectory.properties.capabilities.properties.can_share.description
Right to share Public shared Directory or manage access to Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.capabilities.properties.can_leave.description
Right to leave shared Public shared Directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.capabilities.properties.can_become_dropbox.description
Right to use convert directory into collaborative directory

# components.schemas.91ac10ff_PublicsharedDirectory.properties.lock.properties.locked_at.description
When Public shared Directory is locked, locked timestamp

# components.schemas.91ac10ff_PublicsharedDirectory.properties.lock.properties.unlocked_at.description
When Public shared Directory is locked, automatic lock release timestamp

# components.schemas.91ac10ff_PublicsharedDirectory.properties.lock.properties.description.description
When Public shared Directory is locked, locked reason

# components.schemas.91ac10ff_PublicsharedDirectory.properties.lock.properties.token.description
When Public shared Directory is locked, locked token

# components.schemas.91ac10ff_PublicsharedDirectory.properties.lock.description
When Public shared Directory is locked, locked information

# components.schemas.91ac10ff_PublicsharedDirectory.properties.color.description
Color of the directory for the user requesting it

# components.schemas.91ac10ff_Onlyofficefeedback.properties.error.description
Integer boolean, 0 If the only office content was saved in file, 1 if error happens

# components.schemas.91ac10ff_WopiFileAccess.properties.server_url.description
The corresponding wopi url to load the office preview page from

# components.schemas.91ac10ff_WopiFileAccess.properties.server_inputs.properties.access_token_ttl.description
The access token ttl, a timestamps in ms

# components.schemas.91ac10ff_ArchiveResource.properties.uuid.description
Universally unique identifier of the resource `Archive Resource`

# components.schemas.91ac10ff_TemporaryDbAccess.properties.expires_at_ts.description
Time at which the temporary user will be dropped

# components.schemas.91ac10ff_Storage.properties.id.description
Unique identifier of the resource `Storage`

# components.schemas.91ac10ff_Storage.properties.drives_count.description
Count all non-deleted drives associated with the storage</note>

# components.schemas.91ac10ff_ApplicationServer.properties.id.description
Unique identifier of the resource `Application Server`

# components.schemas.91ac10ff_ApplicationServer.properties.state.description
List of possible server state.backup: The server is currently in backup state. degraded: The server is currently in degraded state. down: The server is currently in down state. failed: The server is currently in failed state. idle: The server is currently in idle state. maintenance: The server is currently in maintenance state. overloaded: The server is currently in overloaded state. restarting: The server is currently in restarting state. starting: The server is currently in starting state. stopping: The server is currently in stopping state. unknown: The server is currently in unknown state. up: The server is currently in up state. updating: The server is currently in updating state.

# components.schemas.91ac10ff_UploadDesktopLogs.properties.message.description
The error code returned, null if no error happens.conflict_error: Conflict detected. In the upload another conflict mode can be used to handle it. file_already_exists_error: Action impossible. The file already exist. forbidden_error: Triggered when user does not have the file permission. lock_error: Action impossible. There is a lock on the file/directory. quota_exceeded_error: Triggered when the quota storage of the drive is reached. upload_by_another_user_not_terminated_error: Another user upload the same file, the upload should be handle with another conflict mode or the user should wait the current upload. upload_error: Triggered when the upload did not finish, you should retry the upload. upload_failed_error: Something is wrong, the received file did not match with the expected parameters (hash, size...), the upload should be restarted. upload_not_terminated_error: Triggered when the upload did not receive all the expected chunks or the file is currently uploading.

# components.schemas.91ac10ff_UserV3.properties.id.description
Unique identifier of the resource `User V3`

# components.schemas.91ac10ff_UserV3.properties.is_sso.description
returns true if the user is provided by an external IDP

# components.schemas.91ac10ff_UserV3.properties.avatar.description
null is returned only when request parameter no_avatar_default=1 and the user has not set an avatar

# components.schemas.91ac10ff_UserV3.properties.security.properties.double_auth_method.description
Double authentication method used to log in

# components.schemas.91ac10ff_UserV3.properties.security.properties.has_double_auth.description
Whether the `User V3` has double authentication enabled

# components.schemas.91ac10ff_UserV3.properties.security.properties.last_password_at.description
Last time `User V3`'s password was changed

# components.schemas.91ac10ff_UserV3.properties.security.properties.has_recovery_email.description
Whether the `User V3` has a recovery email

# components.schemas.91ac10ff_UserV3.properties.security.properties.has_valid_phone.description
Whether the `User V3` has a valid phone number

# components.schemas.91ac10ff_FileDeleted.properties.id.description
Unique identifier of the resource `File Deleted`

# components.schemas.91ac10ff_FileDeleted.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_FileDeleted.properties.visibility.description
Visibility of File Deleted, empty string if no specific visibility. Add additional information about File Deleted to show different icons or more.: Empty visibility mean no special visibility. is_in_private_space: Is a File Deleted inside the private directory of the user. is_in_shared_space: Is a File Deleted inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_in_team_space_folder: Is a File Deleted inside a Common Documents directory. is_private_space: Is the private directory of the user. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_FileDeleted.properties.created_by.description
The identifier of the user who first uploaded the File Deleted

# components.schemas.91ac10ff_FileDeleted.properties.deleted_at.description
Timestamp of deleted resource File Deleted, only visible when the File Deleted is trashed

# components.schemas.91ac10ff_FileDeleted.properties.deleted_by.description
User identifier of deleted resource File Deleted, only visible when the File Deleted is trashed

# components.schemas.91ac10ff_FileDeleted.properties.extension_type.description
File type, properties is not returned for directory type

# components.schemas.91ac10ff_Filecontenthash_73eee26a.properties.chunk_size.description
chunk size in bytes used for multipart file uploads

# components.schemas.91ac10ff_FileVersion.properties.id.description
Unique identifier of the resource `File Version`

# components.schemas.91ac10ff_FileVersion.properties.keep_forever.description
Keep the resource `File Version` forever, otherwise will be delete in 120 days

# components.schemas.91ac10ff_FileVersion.properties.mime_type.description
Mime type of the resource `File Version`

# components.schemas.91ac10ff_FileVersion.properties.extension_type.description
Generic file types, matching a known set of extensions and/or mime types.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# components.schemas.91ac10ff_FileVersion.properties.last_modified_at.description
The last modified date of the file version, null if unknown

# components.schemas.91ac10ff_CursorListing.properties.actions.description
List of `actions` that were performed since last cursor call

# components.schemas.91ac10ff_CursorListing.properties.actions_files.description
List of `File` and `Directory` from all last state of actions

# components.schemas.91ac10ff_Activity.properties.destination.description
Destination of Directory/File in case of move or rename action

# components.schemas.91ac10ff_SharedDirectory.properties.id.description
Unique identifier of the resource `Shared Directory`

# components.schemas.91ac10ff_SharedDirectory.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_SharedDirectory.properties.status.description
Current state of Shared Directory. The state can be null meaning that the Shared Directory has no specific state.locked: Shared Directory is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Shared Directory is available. trash_inherited: Shared Directory is currently in trash because a parent directory was trashed. trashed: Shared Directory is currently in trash and specifically trashed by the user. uploading: Shared Directory is currently being uploaded. The Shared Directory is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_SharedDirectory.properties.visibility.description
Visibility of Shared Directory, empty string if no specific visibility. Add additional information about Shared Directory to show different icons or more.: Empty visibility mean no special visibility. is_in_private_space: Is a Shared Directory inside the private directory of the user. is_in_shared_space: Is a Shared Directory inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_in_team_space_folder: Is a Shared Directory inside a Common Documents directory. is_private_space: Is the private directory of the user. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_SharedDirectory.properties.created_by.description
The identifier of the user who first uploaded the Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.created_at.description
Shared Directory creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_SharedDirectory.properties.added_at.description
The timestamp (in seconds) at which the Shared Directory has been uploaded for the first time

# components.schemas.91ac10ff_SharedDirectory.properties.last_modified_at.description
Shared Directory creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_SharedDirectory.properties.last_modified_by.description
Id of the user who last modified the Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.revised_at.description
The last time the content of the Shared Directory was revised

# components.schemas.91ac10ff_SharedDirectory.properties.updated_at.description
The last time the Shared Directory was updated

# components.schemas.91ac10ff_SharedDirectory.properties.deleted_at.description
Timestamp of deleted resource Shared Directory, only visible when the Shared Directory is trashed

# components.schemas.91ac10ff_SharedDirectory.properties.deleted_by.description
User identifier of deleted resource Shared Directory, only visible when the Shared Directory is trashed

# components.schemas.91ac10ff_SharedDirectory.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_SharedDirectory.properties.users.items.description
Array of users identifiers that has access to the Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.users.description
Array of users identifiers that has access to the Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.teams.items.description
Array of teams identifiers that has access to the Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.teams.description
Array of teams identifiers that has access to the Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.activity.description
Activities information about the Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_SharedDirectory.properties.capabilities.properties.can_show.description
Right to see Shared Directory information

# components.schemas.91ac10ff_SharedDirectory.properties.capabilities.properties.can_share.description
Right to share Shared Directory or manage access to Shared Directory

# components.schemas.91ac10ff_SharedDirectory.properties.capabilities.properties.can_become_dropbox.description
Right to use convert directory into collaborative directory

# components.schemas.91ac10ff_SharedDirectory.properties.capabilities.properties.colorable.description
Right to change or add color to the directory

# components.schemas.91ac10ff_SharedDirectory.properties.lock.properties.locked_at.description
When Shared Directory is locked, locked timestamp

# components.schemas.91ac10ff_SharedDirectory.properties.lock.properties.unlocked_at.description
When Shared Directory is locked, automatic lock release timestamp

# components.schemas.91ac10ff_SharedDirectory.properties.lock.properties.description.description
List of applications.365: The 365 application. external_import: The external_import application. internal_copy: The internal_copy application. internal_import: The internal_import application. onlyoffice: The onlyoffice application. webdav: The webdav application.

# components.schemas.91ac10ff_SharedDirectory.properties.lock.properties.token.description
When Shared Directory is locked, locked token

# components.schemas.91ac10ff_SharedDirectory.properties.lock.description
When Shared Directory is locked, locked information

# components.schemas.91ac10ff_SharedDirectory.properties.color.description
Color of the directory for the user requesting it

# components.schemas.91ac10ff_SharedFile.properties.id.description
Unique identifier of the resource `Shared File`

# components.schemas.91ac10ff_SharedFile.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_SharedFile.properties.status.description
Current state of Shared File. The state can be null meaning that the Shared File has no specific state.locked: Shared File is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Shared File is available. trash_inherited: Shared File is currently in trash because a parent directory was trashed. trashed: Shared File is currently in trash and specifically trashed by the user. uploading: Shared File is currently being uploaded. The Shared File is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_SharedFile.properties.visibility.description
Visibility of Shared File, empty string if no specific visibility. Add additional information about Shared File to show different icons or more.: Empty visibility mean no special visibility. is_in_private_space: Is a Shared File inside the private directory of the user. is_in_shared_space: Is a Shared File inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_in_team_space_folder: Is a Shared File inside a Common Documents directory. is_private_space: Is the private directory of the user. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_SharedFile.properties.created_by.description
The identifier of the user who first uploaded the Shared File

# components.schemas.91ac10ff_SharedFile.properties.created_at.description
Shared File creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_SharedFile.properties.added_at.description
The timestamp (in seconds) at which the Shared File has been uploaded for the first time

# components.schemas.91ac10ff_SharedFile.properties.last_modified_at.description
Shared File creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_SharedFile.properties.last_modified_by.description
Id of the user who last modified the Shared File

# components.schemas.91ac10ff_SharedFile.properties.revised_at.description
The last time the content of the Shared File was revised

# components.schemas.91ac10ff_SharedFile.properties.updated_at.description
The last time the Shared File was updated

# components.schemas.91ac10ff_SharedFile.properties.deleted_at.description
Timestamp of deleted resource Shared File, only visible when the Shared File is trashed

# components.schemas.91ac10ff_SharedFile.properties.deleted_by.description
User identifier of deleted resource Shared File, only visible when the Shared File is trashed

# components.schemas.91ac10ff_SharedFile.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_SharedFile.properties.users.items.description
Array of users identifiers that has access to the Shared File

# components.schemas.91ac10ff_SharedFile.properties.users.description
Array of users identifiers that has access to the Shared File

# components.schemas.91ac10ff_SharedFile.properties.teams.items.description
Array of teams identifiers that has access to the Shared File

# components.schemas.91ac10ff_SharedFile.properties.teams.description
Array of teams identifiers that has access to the Shared File

# components.schemas.91ac10ff_SharedFile.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Shared File

# components.schemas.91ac10ff_SharedFile.properties.activity.description
Activities information about the Shared File

# components.schemas.91ac10ff_SharedFile.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_SharedFile.properties.capabilities.properties.can_share.description
Right to share Shared File or manage access to Shared File

# components.schemas.91ac10ff_SharedFile.properties.lock.properties.locked_at.description
When Shared File is locked, locked timestamp

# components.schemas.91ac10ff_SharedFile.properties.lock.properties.unlocked_at.description
When Shared File is locked, automatic lock release timestamp

# components.schemas.91ac10ff_SharedFile.properties.lock.properties.description.description
List of applications.365: The 365 application. external_import: The external_import application. internal_copy: The internal_copy application. internal_import: The internal_import application. onlyoffice: The onlyoffice application. webdav: The webdav application.

# components.schemas.91ac10ff_SharedFile.properties.lock.properties.token.description
When Shared File is locked, locked token

# components.schemas.91ac10ff_SharedFile.properties.lock.description
When Shared File is locked, locked information

# components.schemas.91ac10ff_SharedFile.properties.size.description
Size of Shared File <note>The unit of size is defined in Bytes</note>

# components.schemas.91ac10ff_SharedFile.properties.extension_type.description
Generic file types, matching a known set of extensions and/or mime types.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# components.schemas.91ac10ff_SharedFile.properties.symbolic_link.description
Symlink target path if the file was uploaded as a symlink

# components.schemas.91ac10ff_SharedFile.properties.scan_status.description
Current state of virus scan for Shared File.cannot_be_scanned: This Shared File cannot be scanned. Possibly because the Shared File is too large. clean: This Shared File has been successfully scanned for known viruses. error: An error occurred while scanning the Shared File. infected: This Shared File has been detected as infected by a virus. not_to_be_scanned: This Shared File is not eligible to be scanned. Possibly because the Shared File is empty. pua: This Shared File has been detected as Potentially Unwanted Applications (PUA).to_be_defined: The status for this Shared File has not yet been determined. to_be_scan: This Shared File will be analyzed soon.

# components.schemas.91ac10ff_SharedFile.properties.supported_by.description
List of applications.365: The 365 application. drawio: The drawio application. kmail: The kmail application. onlyoffice: The onlyoffice application. thumbnail: Thumbnail is preview and thumbnail.

# components.schemas.91ac10ff_SharedFile.properties.version.properties.total_size.description
Size of the file with all version  (byte unit)

# components.schemas.91ac10ff_SharedFile.properties.version.properties.keep_forever.description
True if the current version of this file should be kept forever, otherwise false or empty

# components.schemas.91ac10ff_SharedFile.properties.conversion_capabilities.properties.when_downloading.description
Whether the file may be converted upon download

# components.schemas.91ac10ff_SharedFile.properties.conversion_capabilities.properties.download_extensions.items.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_SharedFile.properties.conversion_capabilities.properties.download_extensions.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_SharedFile.properties.conversion_capabilities.properties.when_onlyoffice_opening.description
Whether the file may be converted for live edition with OnlyOffice

# components.schemas.91ac10ff_SharedFile.properties.conversion_capabilities.properties.onlyoffice_extension.description
Available extension to which the file may be converted by OnlyOffice, if possible

# components.schemas.91ac10ff_SharedFile.properties.relevance.description
the relevance score between 0 and 1 or date

# components.schemas.91ac10ff_Cursor.properties.source_id.description
ID of the directory the cursor was created in

# components.schemas.91ac10ff_Cursor.properties.source_path.description
Path of the directory the cursor was created in

# components.schemas.91ac10ff_Cursor.properties.activity_id.description
ID of the last activity seen by the cursor

# components.schemas.91ac10ff_Cursor.properties.recursive.description
Whether the cursor also reads children directories

# components.schemas.91ac10ff_Cursor.properties.actions.items.description
Logged interaction type of activities on the drive or file.acl_insert: Technical: when a new group access to a file/directory is create. acl_main_users_insert: Logged when the main kDrive team access to a file/directory is created. acl_main_users_remove: Logged when the main kDrive team to a file/directory is removed. acl_main_users_update: Logged when the main kDrive team to a file/directory is modified. acl_remove: Technical: when a group access to a file/directory is removed. acl_team_insert: Logged when a team access to a file/directory is created. acl_team_remove: Logged when a team access to a file/directory is removed. acl_team_update: Logged when a team access to a file/directory is modified. acl_update: Technical: when a group access to a file/directory is modified. acl_user_insert: Logged when an user/admin access to a file/directory is created. acl_user_remove: Logged when an user/admin access to a file/directory is removed. acl_user_update: Logged when an user/admin access to a file/directory is modified. category_create: Logged when a new category is added. category_delete: Logged when a category is deleted. category_update: Logged when a category is renamed. collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. exchange_pro_create: Technical: no used. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. file_update_mime_type: Logged when a file mime_type is updated. maintenance_added: Logged when a maintenance start. maintenance_removed: Logged when a maintenance ends. rewind_ended: Logged when the user ended a rewind. rewind_started: Logged when the user started a rewind. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified. trash_empty: Logged when the user empties the trash. trash_empty_auto: Logged when the trash empties old files automatically. update_trash_settings: Logged when the user changes trash the settings. user_connected: Logged when an user is connected to the drive. user_create: Logged when an user/admin is added to the drive. user_delete: Logged when an user/admin has been removed of the drive. user_restore: Logged when an user/admin has been restored of the drive. user_update: Logged when an user/admin information has changed.

# components.schemas.91ac10ff_Cursor.properties.actions.description
Logged interaction type of activities on the drive or file.acl_insert: Technical: when a new group access to a file/directory is create. acl_main_users_insert: Logged when the main kDrive team access to a file/directory is created. acl_main_users_remove: Logged when the main kDrive team to a file/directory is removed. acl_main_users_update: Logged when the main kDrive team to a file/directory is modified. acl_remove: Technical: when a group access to a file/directory is removed. acl_team_insert: Logged when a team access to a file/directory is created. acl_team_remove: Logged when a team access to a file/directory is removed. acl_team_update: Logged when a team access to a file/directory is modified. acl_update: Technical: when a group access to a file/directory is modified. acl_user_insert: Logged when an user/admin access to a file/directory is created. acl_user_remove: Logged when an user/admin access to a file/directory is removed. acl_user_update: Logged when an user/admin access to a file/directory is modified. category_create: Logged when a new category is added. category_delete: Logged when a category is deleted. category_update: Logged when a category is renamed. collaborative_folder_access: Logged when an user/guest access to the dropbox. collaborative_folder_create: Logged when an user create a dropbox. collaborative_folder_delete: Logged when an user delete the dropbox. collaborative_folder_update: Logged when an user update settings of the dropbox. collaborative_user_access: Logged when an user/guest upload to the dropbox. collaborative_user_create: Logged when an user/guest add his information before uploading to the dropbox. collaborative_user_delete: Logged when an user remove the directory to the dropbox. comment_create: Logged when an user/admin add a comment on a file. comment_delete: Logged when an user/admin delete a comment on a file. comment_like: Logged when an user/admin like a comment on a file. comment_resolve: Logged when an user/admin resolve a comment on a file. comment_unlike: Logged when an user/admin unlike a comment on a file. comment_update: Logged when an user/admin update a comment on a file. exchange_pro_create: Technical: no used. file_access: Logged when an user/guest access to the file. file_categorize: Logged when a category is added to the file/directory. file_color_delete: Logged when a directory color is removed. file_color_update: Logged when a directory color changed. file_create: Logged when on the first file creation. file_delete: Logged when the file is deleted. file_favorite_create: Logged when a file/directory is flagged as favorites. file_favorite_remove: Logged when a file/directory is unflagged from favorites. file_ia_categorize: Logged when a file is categorized by the ia. file_move: Logged when the file is added inside a directory. file_move_out: Logged when the file is removed from a directory. file_rename: Logged when the file is renamed. file_rename_alias: Logged when a root file is renamed by an external user (only visible for the external user).file_restore: Logged when the file is restored from the trash. file_share_create: Logged when an external user access to a file/directory is created. file_share_delete: Logged when an external user access to a file/directory is removed. file_share_update: Logged when an external user access to a file/directory is modified to another permission. file_trash: Logged when the file is sent to trash. file_uncategorize: Logged when a category is removed to the file/directory. file_update: Logged when the file is updated. file_update_mime_type: Logged when a file mime_type is updated. maintenance_added: Logged when a maintenance start. maintenance_removed: Logged when a maintenance ends. rewind_ended: Logged when the user ended a rewind. rewind_started: Logged when the user started a rewind. share_link_create: Logged when a public share link to a file/directory is created. share_link_delete: Logged when a public share link to a file/directory is deleted. share_link_show: Logged when a public share link to a file/directory is seen by someone else. share_link_update: Logged when a public share link to a file/directory is modified. trash_empty: Logged when the user empties the trash. trash_empty_auto: Logged when the trash empties old files automatically. update_trash_settings: Logged when the user changes trash the settings. user_connected: Logged when an user is connected to the drive. user_create: Logged when an user/admin is added to the drive. user_delete: Logged when an user/admin has been removed of the drive. user_restore: Logged when an user/admin has been restored of the drive. user_update: Logged when an user/admin information has changed.

# components.schemas.91ac10ff_PublicsharedFileV3.properties.id.description
Unique identifier of the resource `Public shared File V3`

# components.schemas.91ac10ff_PublicsharedFileV3.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_PublicsharedFileV3.properties.status.description
Current state of Public shared File V3. The state can be null meaning that the Public shared File V3 has no specific state.locked: Public shared File V3 is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Public shared File V3 is available. trash_inherited: Public shared File V3 is currently in trash because a parent directory was trashed. trashed: Public shared File V3 is currently in trash and specifically trashed by the user. uploading: Public shared File V3 is currently being uploaded. The Public shared File V3 is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_PublicsharedFileV3.properties.visibility.description
Visibility of Public shared File V3, empty string if no specific visibility. Add additional information about Public shared File V3 to show different icons or more.: Empty visibility mean no special visibility. is_in_private_space: Is a Public shared File V3 inside the private directory of the user. is_in_shared_space: Is a Public shared File V3 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_in_team_space_folder: Is a Public shared File V3 inside a Common Documents directory. is_private_space: Is the private directory of the user. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_PublicsharedFileV3.properties.depth.description
Current path depth of Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.created_by.description
The identifier of the user who first uploaded the Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.created_at.description
Public shared File V3 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_PublicsharedFileV3.properties.added_at.description
The timestamp (in seconds) at which the Public shared File V3 has been uploaded for the first time

# components.schemas.91ac10ff_PublicsharedFileV3.properties.last_modified_at.description
Public shared File V3 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_PublicsharedFileV3.properties.last_modified_by.description
Id of the user who last modified the Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.revised_at.description
The last time the content of the Public shared File V3 was revised

# components.schemas.91ac10ff_PublicsharedFileV3.properties.updated_at.description
The last time the Public shared File V3 was updated

# components.schemas.91ac10ff_PublicsharedFileV3.properties.deleted_at.description
Timestamp of deleted resource Public shared File V3, only visible when the Public shared File V3 is trashed

# components.schemas.91ac10ff_PublicsharedFileV3.properties.deleted_by.description
User identifier of deleted resource Public shared File V3, only visible when the Public shared File V3 is trashed

# components.schemas.91ac10ff_PublicsharedFileV3.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_PublicsharedFileV3.properties.users.items.description
Array of users identifiers that has access to the Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.users.description
Array of users identifiers that has access to the Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.teams.items.description
Array of teams identifiers that has access to the Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.teams.description
Array of teams identifiers that has access to the Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.is_favorite.description
Is Public shared File V3 pinned as favorite

# components.schemas.91ac10ff_PublicsharedFileV3.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.activity.description
Activities information about the Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_PublicsharedFileV3.properties.capabilities.properties.can_show.description
Right to see Public shared File V3 information

# components.schemas.91ac10ff_PublicsharedFileV3.properties.capabilities.properties.can_read.description
Right to read Public shared File V3 content

# components.schemas.91ac10ff_PublicsharedFileV3.properties.capabilities.properties.can_share.description
Right to share Public shared File V3 or manage access to Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.capabilities.properties.can_leave.description
Right to leave shared Public shared File V3

# components.schemas.91ac10ff_PublicsharedFileV3.properties.lock.properties.locked_at.description
When Public shared File V3 is locked, locked timestamp

# components.schemas.91ac10ff_PublicsharedFileV3.properties.lock.properties.unlocked_at.description
When Public shared File V3 is locked, automatic lock release timestamp

# components.schemas.91ac10ff_PublicsharedFileV3.properties.lock.properties.description.description
List of applications.365: The 365 application. external_import: The external_import application. internal_copy: The internal_copy application. internal_import: The internal_import application. onlyoffice: The onlyoffice application. webdav: The webdav application.

# components.schemas.91ac10ff_PublicsharedFileV3.properties.lock.properties.token.description
When Public shared File V3 is locked, locked token

# components.schemas.91ac10ff_PublicsharedFileV3.properties.lock.description
When Public shared File V3 is locked, locked information

# components.schemas.91ac10ff_PublicsharedFileV3.properties.size.description
Size of Public shared File V3 <note>The unit of size is defined in Bytes</note>

# components.schemas.91ac10ff_PublicsharedFileV3.properties.extension_type.description
Generic file types, matching a known set of extensions and/or mime types.archive: Archive file. audio: Audio only file. code: Text file recognized as code. diagram: Diagram file. dir: Directory. email: Bundled email file. font: Text file recognized as font. form: Form file. image: Image file. model: 3D file. pdf: PDF file. presentation: Presentation/slides file. spreadsheet: Spreadsheet file. text: Generic text file. unknown: Generic file, not recognized as any of the other type. video: Video file; may contain other stream types such as audio or subtitles.

# components.schemas.91ac10ff_PublicsharedFileV3.properties.symbolic_link.description
Symlink target path if the file was uploaded as a symlink

# components.schemas.91ac10ff_PublicsharedFileV3.properties.scan_status.description
Current state of virus scan for Public shared File V3.cannot_be_scanned: This Public shared File V3 cannot be scanned. Possibly because the Public shared File V3 is too large. clean: This Public shared File V3 has been successfully scanned for known viruses. error: An error occurred while scanning the Public shared File V3. infected: This Public shared File V3 has been detected as infected by a virus. not_to_be_scanned: This Public shared File V3 is not eligible to be scanned. Possibly because the Public shared File V3 is empty. pua: This Public shared File V3 has been detected as Potentially Unwanted Applications (PUA).to_be_defined: The status for this Public shared File V3 has not yet been determined. to_be_scan: This Public shared File V3 will be analyzed soon.

# components.schemas.91ac10ff_PublicsharedFileV3.properties.supported_by.description
List of applications.365: The 365 application. drawio: The drawio application. kmail: The kmail application. onlyoffice: The onlyoffice application. thumbnail: Thumbnail is preview and thumbnail.

# components.schemas.91ac10ff_PublicsharedFileV3.properties.version.properties.total_size.description
Size of the file with all version  (byte unit)

# components.schemas.91ac10ff_PublicsharedFileV3.properties.version.properties.keep_forever.description
True if the current version of this file should be kept forever, otherwise false or empty

# components.schemas.91ac10ff_PublicsharedFileV3.properties.conversion_capabilities.properties.when_downloading.description
Whether the file may be converted upon download

# components.schemas.91ac10ff_PublicsharedFileV3.properties.conversion_capabilities.properties.download_extensions.items.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_PublicsharedFileV3.properties.conversion_capabilities.properties.download_extensions.description
Available extensions to which the file may be converted upon download, if possible

# components.schemas.91ac10ff_PublicsharedFileV3.properties.conversion_capabilities.properties.when_onlyoffice_opening.description
Whether the file may be converted for live edition with OnlyOffice

# components.schemas.91ac10ff_PublicsharedFileV3.properties.conversion_capabilities.properties.onlyoffice_extension.description
Available extension to which the file may be converted by OnlyOffice, if possible

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.id.description
Unique identifier of the resource `Public shared Directory V3`

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.path.description
Full path of the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.type.description
Type of returned element either a dir (Directory) or file (File)

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.status.description
Current state of Public shared Directory V3. The state can be null meaning that the Public shared Directory V3 has no specific state.locked: Public shared Directory V3 is currently locked. No action can be made except unlocking by the application which locked the File (such as office, webdav or external import).ok: Public shared Directory V3 is available. trash_inherited: Public shared Directory V3 is currently in trash because a parent directory was trashed. trashed: Public shared Directory V3 is currently in trash and specifically trashed by the user. uploading: Public shared Directory V3 is currently being uploaded. The Public shared Directory V3 is locked and no action can be done excepting upload actions.

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.visibility.description
Visibility of Public shared Directory V3, empty string if no specific visibility. Add additional information about Public shared Directory V3 to show different icons or more.: Empty visibility mean no special visibility. is_in_private_space: Is a Public shared Directory V3 inside the private directory of the user. is_in_shared_space: Is a Public shared Directory V3 inside the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_in_team_space_folder: Is a Public shared Directory V3 inside a Common Documents directory. is_private_space: Is the private directory of the user. is_root: Is the root directory of the user. is_shared_space: Is the shared root directory, a special directory where the files inside are the private files of other user shared with the logged user. is_team_space: Is the Common Documents directory, a special directory where the files inside are common to all users by default. is_team_space_folder: Is the root directory inside the Common Documents.

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.depth.description
Current path depth of Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.created_by.description
The identifier of the user who first uploaded the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.created_at.description
Public shared Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.added_at.description
The timestamp (in seconds) at which the Public shared Directory V3 has been uploaded for the first time

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.last_modified_at.description
Public shared Directory V3 creation timestamp (in seconds), if available in its metadata or specified on upload

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.last_modified_by.description
Id of the user who last modified the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.revised_at.description
The last time the content of the Public shared Directory V3 was revised

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.updated_at.description
The last time the Public shared Directory V3 was updated

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.deleted_at.description
Timestamp of deleted resource Public shared Directory V3, only visible when the Public shared Directory V3 is trashed

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.deleted_by.description
User identifier of deleted resource Public shared Directory V3, only visible when the Public shared Directory V3 is trashed

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.shared_root_id.description
Root Directory identifier, only visible for shared user

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.users.items.description
Array of users identifiers that has access to the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.users.description
Array of users identifiers that has access to the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.teams.items.description
Array of teams identifiers that has access to the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.teams.description
Array of teams identifiers that has access to the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.is_favorite.description
Is Public shared Directory V3 pinned as favorite

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.activity.properties.last_accessed_at.description
Timestamp of the last user access of the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.activity.description
Activities information about the Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_become_sharelink.description
Right to share file by link (share_link)

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_show.description
Right to see Public shared Directory V3 information

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_read.description
Right to read Public shared Directory V3 content

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_write.description
Right to write Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_share.description
Right to share Public shared Directory V3 or manage access to Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_leave.description
Right to leave shared Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_delete.description
Right to delete Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_rename.description
Right to rename Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_move.description
Right to move Public shared Directory V3

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.can_become_dropbox.description
Right to use convert directory into collaborative directory

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.capabilities.properties.colorable.description
Right to change or add color to the directory

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.lock.properties.locked_at.description
When Public shared Directory V3 is locked, locked timestamp

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.lock.properties.unlocked_at.description
When Public shared Directory V3 is locked, automatic lock release timestamp

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.lock.properties.description.description
List of applications.365: The 365 application. external_import: The external_import application. internal_copy: The internal_copy application. internal_import: The internal_import application. onlyoffice: The onlyoffice application. webdav: The webdav application.

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.lock.properties.token.description
When Public shared Directory V3 is locked, locked token

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.lock.description
When Public shared Directory V3 is locked, locked information

# components.schemas.91ac10ff_PublicsharedDirectoryV3.properties.color.description
Color of the directory for the user requesting it

# components.schemas.75461840_PremiumSupport.properties.emergency.description
url allowing the client to ask support to call him in emergency case

# components.parameters.Page.description
*Optional parameter* that define the page number<br />
Part of the `pagination` capacity

# components.parameters.PerPage.description
*Optional parameter* that define the number of items per page<br />
Part of the `pagination` capacity

# components.parameters.Return.description
*Optional* :  If you pass this parameter with the value `total`, then the response will be the number of items in the collection, instead of the items themselves.<br />
Part of the `total` capacity

# components.parameters.OrderBy.description
*Optional parameter* that define the field used for sorting<br />
Part of the `sort` capacity

# components.parameters.Order.description
*Optional parameter* that define the default sort order<br />
Part of the `sort` capacity

# components.parameters.OrderFor.description
*Optional parameter* that define the sorting order for a field
By default **order** is used
Part of the `sort` capacity

# components.parameters.Limit.description
*Optional parameter* that define the number of items to return<br />
Part of the `offset` capacity

# components.parameters.Skip.description
*Optional parameter* that define the index of the first item to return (0 = first item)<br />
Part of the `offset` capacity

# components.parameters.Async.description
*Optional* :  If you pass this parameter then the response will be asynchronous.<br />
Part of the `asynchronous` capacity

# components.parameters.Total.description
If set to true, return the total number of items. Total pages (pages) in response is also returned.
You can also use ?with=total parameter

# components.responses.1.description
Access to the resource is forbidden for this user.

# components.responses.3.description
There was an internal error in the server.

# components.responses.BadRequest.description
Invalid or missing parameters in URL or request body

# x-tagGroups[].tags[]
Privates > Multiples > Channel > Geolocation

# x-tagGroups[].tags[]
Privates > Multiples > Channel > Histograms

# x-tagGroups[].tags[]
Profile > Two Factor > Authenticator > Passkeys

# x-tagGroups[].tags[]
User Management > Accounts > Invitations

# x-tagGroups[].tags[]
User Management > Accounts > Invitations > B2B

# x-tagGroups[].tags[]
User Management > Accounts > Invitations > Drive

# x-tagGroups[].tags[]
User Management > Accounts > Invitations > KChat

# x-tagGroups[].tags[]
User Management > Accounts > Invitations > Mailbox

# x-tagGroups[].tags[]
User Management > Accounts > Invitations > kSuite

# x-tagGroups[].tags[]
Drive > Files > File/Directory > Access > Invitation

# x-tagGroups[].tags[]
Drive > Files > File/Directory > Access > Permission

# x-tagGroups[].tags[]
Drive > Files > File/Directory > Access > Request

# x-tagGroups[].tags[]
Drive > Files > File/Directory > Access > Teams

# x-tagGroups[].tags[]
Drive > Files > File/Directory > Access > Users

# x-tagGroups[].tags[]
Drive > Files > File/Directory > Comment

# x-tagGroups[].tags[]
Drive > Files > File/Directory > Upload > Session

# x-tagGroups[].tags[]
Drive > Files > File/Directory > Version