Cloud France
Enrich your service with Orange Cloud, the personal online storage service available to our mobile & broadband customers. Access, upload and manage content.

Cloud API

The Cloud API limits you to a dedicated folder, created within the Cloud of the end-user the first time your application uploads a file. For French users, this folder is located in "mes dossiers partenaires" with the name of your application. Your application will have the full freedom to create directories, manipulate files and folders, upload, download, delete, within this folder.

[BASE URL: /cloud/v1, API VERSION: v1.5, HOST: https://api.orange.com]
    • implementation notes

      Returns the status

      response class (status 200)
      {
        "name": "myproxy_v1",
        "status": "ok",
        "version": "1.0.9",
        "components": [
          {
            "status": "ok",
            "version": "v1.1",
            "name": "redis"
          }
        ]
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      503http status
      {
        "name": "myproxy_v1",
        "status": "ok",
        "version": "1.0.9",
        "components": [
          {
            "status": "ok",
            "version": "v1.1",
            "name": "redis"
          }
        ]
      }
      defaultError
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Rename, move or copy a file. To rename a file, use the 'name' attribute. To move a file, use the 'parentFolderId'. To copy a file, use both 'parentFolderId' and 'clone' (set to true).

      response class (status 201)
      {
        "id": "string",
        "name": "string",
        "parentId": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      (required)
      pathstring
      'name' and 'parentFolderId'/'clone' are exclusive. 'clone' is optional. If not transmitted, it is set to false.body
      {
        "name": "string",
        "parentFolderId": "string",
        "clone": false
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400List of error codes:
      - 800: *INVALID_PARAMETER - A mandatory input is invalid (refer to error details). Please check your request and retry.
      - 800: *MISSING_PARAMETER - A mandatory input is missing (refer to error details). Please enrich your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      403List of error codes:
      - 800: *FORBIDDEN_ACCESS - The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      - 800: PDK_*-USER_NOT_ELIGIBLE - The end user is not eligible to the Cloud service. Please inform the user and may redirect them to the service landing page. Use the following message:
      -- [English]: You do not have an Orange Cloud. For further information, please connect to the Orange Cloud website.
      -- [French]: Vous n'avez pas de Cloud Orange. Pour plus d'informations, veuillez vous connecter au site du Cloud Orange.
      - 800: PDK_CW_*-CGU_NOT_ACCEPTED - The end user should accept the ToU prior to accessing the Cloud service. The end user should be redirected to the service landing page. Please, use the following message:
      -- [English]: To connect to your Orange Cloud, thanks to first validate the service Terms & Conditions.
      -- [French]: Pour vous connecter à votre Cloud Orange, vous devez au préalable valider les Conditions Générales d'Utilisation du service.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      404List of error codes:
      - 800: *NOT_FOUND - The requested resource does not exist. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      409List of error codes:
      - 800: *ALREADY_EXISTS - The requested resource already exists. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Retrieve the given file information. The result also contains the URL to be used to download the given file.

      response class (status 200)
      {
        "id": "string",
        "name": "string",
        "size": 0,
        "creationDate": "2017-12-12T16:00:14.707Z",
        "lastUpdateDate": "2017-12-12T16:00:14.707Z",
        "type": "FILE",
        "downloadUrl": "string",
        "previewUrl": "string",
        "thumbUrl": "string",
        "metaData": {}
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      (required)
      pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400List of error codes:
      - 800: *INVALID_PARAMETER - A mandatory input is invalid (refer to error details). Please check your request and retry.
      - 800: *MISSING_PARAMETER - A mandatory input is missing (refer to error details). Please enrich your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      403List of error codes:
      - 800: *FORBIDDEN_ACCESS - The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      - 800: PDK_*-USER_NOT_ELIGIBLE - The end user is not eligible to the Cloud service. Please inform the user and may redirect them to the service landing page. Use the following message:
      -- [English]: You do not have an Orange Cloud. For further information, please connect to the Orange Cloud website.
      -- [French]: Vous n'avez pas de Cloud Orange. Pour plus d'informations, veuillez vous connecter au site du Cloud Orange.
      - 800: PDK_CW_*-CGU_NOT_ACCEPTED - The end user should accept the ToU prior to accessing the Cloud service. The end user should be redirected to the service landing page. Please, use the following message:
      -- [English]: To connect to your Orange Cloud, thanks to first validate the service Terms & Conditions.
      -- [French]: Pour vous connecter à votre Cloud Orange, vous devez au préalable valider les Conditions Générales d'Utilisation du service.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      404List of error codes:
      - 800: *NOT_FOUND - The requested resource does not exist. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Delete the given file.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      (required)
      pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Successful response
      400List of error codes:
      - 800: *INVALID_PARAMETER - A mandatory input is invalid (refer to error details). Please check your request and retry.
      - 800: *MISSING_PARAMETER - A mandatory input is missing (refer to error details). Please enrich your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      403List of error codes:
      - 800: *FORBIDDEN_ACCESS - The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      - 800: PDK_*-USER_NOT_ELIGIBLE - The end user is not eligible to the Cloud service. Please inform the user and may redirect them to the service landing page. Use the following message:
      -- [English]: You do not have an Orange Cloud. For further information, please connect to the Orange Cloud website.
      -- [French]: Vous n'avez pas de Cloud Orange. Pour plus d'informations, veuillez vous connecter au site du Cloud Orange.
      - 800: PDK_CW_*-CGU_NOT_ACCEPTED - The end user should accept the ToU prior to accessing the Cloud service. The end user should be redirected to the service landing page. Please, use the following message:
      -- [English]: To connect to your Orange Cloud, thanks to first validate the service Terms & Conditions.
      -- [French]: Pour vous connecter à votre Cloud Orange, vous devez au préalable valider les Conditions Générales d'Utilisation du service.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      404List of error codes:
      - 800: *NOT_FOUND - The requested resource does not exist. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Delete the given folder and all its contents (even sub folders) from the cloud.

      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      (required)
      pathstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      204Successful response
      400List of error codes:
      - 800: *INVALID_PARAMETER - A mandatory input is invalid (refer to error details). Please check your request and retry.
      - 800: *MISSING_PARAMETER - A mandatory input is missing (refer to error details). Please enrich your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      403List of error codes:
      - 800: *FORBIDDEN\_ACCESS - The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      - 800: PDK_*-USER_NOT_ELIGIBLE - The end user is not eligible to the Cloud service. Please inform the user and may redirect them to the service landing page. Use the following message:
      -- [English]: You do not have an Orange Cloud. For further information, please connect to the Orange Cloud website.
      -- [French]: Vous n'avez pas de Cloud Orange. Pour plus d'informations, veuillez vous connecter au site du Cloud Orange.
      - 800: PDK_CW_*-CGU_NOT_ACCEPTED - The end user should accept the ToU prior to accessing the Cloud service. The end user should be redirected to the service landing page. Please, use the following message:
      -- [English]: To connect to your Orange Cloud, thanks to first validate the service Terms & Conditions.
      -- [French]: Pour vous connecter à votre Cloud Orange, vous devez au préalable valider les Conditions Générales d'Utilisation du service.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      404List of error codes:
      - 800: *NOT_FOUND - The requested resource does not exist. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Browse a folder and list its contents (files and sub-folders).

      response class (status 200)
      {
        "id": "string",
        "parentId": "string",
        "name": "string",
        "files": [
          {
            "id": "string",
            "name": "string",
            "size": 0,
            "creationDate": "2017-12-12T16:00:14.707Z",
            "lastUpdateDate": "2017-12-12T16:00:14.707Z",
            "type": "FILE",
            "downloadUrl": "string",
            "previewUrl": "string",
            "thumbUrl": "string",
            "metaData": {}
          }
        ],
        "subFolders": [
          {
            "id": "string",
            "name": "string",
            "parentId": "string"
          }
        ]
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      (required)
      pathstring
      Optional parameter. If present, the application folder will be considered as the root folder, even in full mode.querystring
      Optional parameter. If present, the response will contain the thumbnail/preview/download urls for every listed file.querystring
      image or  video or  audio or  other
      Optional parameter. If present, restricts the result to a specified universe. Valid values are [image|video|audio|other].querystring
      Optional parameter. 'false' by default. If set to 'true', the folder will be browsed recursively and the full content will be returned.queryboolean
      Optional parameter. 'false' by default. If set to 'true', only subfolders will be returned.queryboolean
      Optional pagination parameter. Specifies the maximum number of elements to be listed. Unlimited by default (set to 0).queryinteger
      Optional pagination parameter. Specifies the offset of the first element to be listed. Default value is 0.queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400List of error codes:
      - 800: *INVALID_PARAMETER - A mandatory input is invalid (refer to error details). Please check your request and retry.
      - 800: *MISSING_PARAMETER - A mandatory input is missing (refer to error details). Please enrich your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      403List of error codes:
      - 800: *FORBIDDEN_ACCESS - The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      - 800: PDK_*-USER_NOT_ELIGIBLE - The end user is not eligible to the Cloud service. Please inform the user and may redirect them to the service landing page. Use the following message:
      -- [English]: You do not have an Orange Cloud. For further information, please connect to the Orange Cloud website.
      -- [French]: Vous n'avez pas de Cloud Orange. Pour plus d'informations, veuillez vous connecter au site du Cloud Orange.
      - 800: PDK_CW_*-CGU_NOT_ACCEPTED - The end user should accept the ToU prior to accessing the Cloud service. The end user should be redirected to the service landing page. Please, use the following message:
      -- [English]: To connect to your Orange Cloud, thanks to first validate the service Terms & Conditions.
      -- [French]: Pour vous connecter à votre Cloud Orange, vous devez au préalable valider les Conditions Générales d'Utilisation du service.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      404List of error codes:
      - 800: *NOT_FOUND - The requested resource does not exist. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Rename, move or copy a folder. To rename a folder, use the 'name' attribute. To move a folder, use the 'parentFolderId'. To copy a folder, use both 'parentFolderId' and 'clone' (set to true).

      response class (status 201)
      {
        "id": "string",
        "name": "string",
        "parentId": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      (required)
      pathstring
      'name' and 'parentFolderId'/'clone' are exclusive. 'clone' is optional. If not transmitted, it is set to false.body
      {
        "name": "string",
        "parentFolderId": "string",
        "clone": false
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400List of error codes:
      - 800: *INVALID_PARAMETER - A mandatory input is invalid (refer to error details). Please check your request and retry.
      - 800: *MISSING_PARAMETER - A mandatory input is missing (refer to error details). Please enrich your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      403List of error codes:
      - 800: *FORBIDDEN_ACCESS - The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      - 800: PDK_*-USER_NOT_ELIGIBLE - The end user is not eligible to the Cloud service. Please inform the user and may redirect them to the service landing page. Use the following message:
      -- [English]: You do not have an Orange Cloud. For further information, please connect to the Orange Cloud website.
      -- [French]: Vous n'avez pas de Cloud Orange. Pour plus d'informations, veuillez vous connecter au site du Cloud Orange.
      - 800: PDK_CW_*-CGU_NOT_ACCEPTED - The end user should accept the ToU prior to accessing the Cloud service. The end user should be redirected to the service landing page. Please, use the following message:
      -- [English]: To connect to your Orange Cloud, thanks to first validate the service Terms & Conditions.
      -- [French]: Pour vous connecter à votre Cloud Orange, vous devez au préalable valider les Conditions Générales d'Utilisation du service.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      404List of error codes:
      - 800: *NOT_FOUND - The requested resource does not exist. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      409List of error codes:
      - 800: *ALREADY_EXISTS - The requested resource already exists. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Browse the root folder and list its contents (files and sub-folders).

      response class (status 200)
      {
        "id": "string",
        "parentId": "string",
        "name": "string",
        "files": [
          {
            "id": "string",
            "name": "string",
            "size": 0,
            "creationDate": "2017-12-12T16:00:14.707Z",
            "lastUpdateDate": "2017-12-12T16:00:14.707Z",
            "type": "FILE",
            "downloadUrl": "string",
            "previewUrl": "string",
            "thumbUrl": "string",
            "metaData": {}
          }
        ],
        "subFolders": [
          {
            "id": "string",
            "name": "string",
            "parentId": "string"
          }
        ]
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      Optional parameter. If present, the application folder will be considered as the root folder, even in full mode.querystring
      Optional parameter. If present, the response will contain the thumbnail/preview/download urls for every listed file.querystring
      image or  video or  audio or  other
      Optional parameter. If present, restricts the result to a specified universe. Valid values are [image|video|audio|other].querystring
      Optional parameter. 'false' by default. If set to 'true', the folder will be browsed recursively and the full content will be returned.queryboolean
      Optional parameter. 'false' by default. If set to 'true', only subfolders will be returned.queryboolean
      Optional pagination parameter. Specifies the maximum number of elements to be listed. Unlimited by default (set to 0).queryinteger
      Optional pagination parameter. Specifies the offset of the first element to be listed. Default value is 0.queryinteger
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400List of error codes:
      - 800: *INVALID_PARAMETER - A mandatory input is invalid (refer to error details). Please check your request and retry.
      - 800: *MISSING_PARAMETER - A mandatory input is missing (refer to error details). Please enrich your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      403List of error codes:
      - 800: *FORBIDDEN_ACCESS - The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      - 800: PDK_*-USER_NOT_ELIGIBLE - The end user is not eligible to the Cloud service. Please inform the user and may redirect them to the service landing page. Use the following message:
      -- [English]: You do not have an Orange Cloud. For further information, please connect to the Orange Cloud website.
      -- [French]: Vous n'avez pas de Cloud Orange. Pour plus d'informations, veuillez vous connecter au site du Cloud Orange.
      - 800: PDK_CW_*-CGU_NOT_ACCEPTED - The end user should accept the ToU prior to accessing the Cloud service. The end user should be redirected to the service landing page. Please, use the following message:
      -- [English]: To connect to your Orange Cloud, thanks to first validate the service Terms & Conditions.
      -- [French]: Pour vous connecter à votre Cloud Orange, vous devez au préalable valider les Conditions Générales d'Utilisation du service.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Create a folder in the specified parent folder. If no parent folder is defined, the folder is created at root level.

      response class (status 201)
      {
        "id": "string",
        "parentId": "string",
        "name": "string",
        "files": [
          {
            "id": "string",
            "name": "string",
            "size": 0,
            "creationDate": "2017-12-12T16:00:14.707Z",
            "lastUpdateDate": "2017-12-12T16:00:14.707Z",
            "type": "FILE",
            "downloadUrl": "string",
            "previewUrl": "string",
            "thumbUrl": "string",
            "metaData": {}
          }
        ],
        "subFolders": [
          {
            "id": "string",
            "name": "string",
            "parentId": "string"
          }
        ]
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      body
      {
        "name": "string",
        "parentFolderId": "string"
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400List of error codes:
      - 800: *INVALID_PARAMETER - A mandatory input is invalid (refer to error details). Please check your request and retry.
      - 800: *MISSING_PARAMETER - A mandatory input is missing (refer to error details). Please enrich your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      403List of error codes:
      - 800: *FORBIDDEN_ACCESS - The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      - 800: PDK_*-USER_NOT_ELIGIBLE - The end user is not eligible to the Cloud service. Please inform the user and may redirect them to the service landing page. Use the following message:
      -- [English]: You do not have an Orange Cloud. For further information, please connect to the Orange Cloud website.
      -- [French]: Vous n'avez pas de Cloud Orange. Pour plus d'informations, veuillez vous connecter au site du Cloud Orange.
      - 800: PDK_CW_*-CGU_NOT_ACCEPTED - The end user should accept the ToU prior to accessing the Cloud service. The end user should be redirected to the service landing page. Please, use the following message:
      -- [English]: To connect to your Orange Cloud, thanks to first validate the service Terms & Conditions.
      -- [French]: Pour vous connecter à votre Cloud Orange, vous devez au préalable valider les Conditions Générales d'Utilisation du service.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      409List of error codes:
      - 800: *ALREADY_EXISTS - The requested resource already exists. Please check your request and retry.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Retrieve the available space on the user's cloud. Note that this data is not real-time computed: it can take a couple of minutes after a deletion or an upload to get the actual remaining free space.

      response class (status 200)
      {
        "freespace": 0
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      500List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact the our support team.
      - 800: *SESSION_EXPIRED - Current session has expired. Please initialize a new session by calling the 'Init session' method.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      501List of error codes:
      - 800: *UNSUPPORTED_COUNTRY - Country not supported. Please inform the end user that the service is not available yet.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      503List of error codes:
      - 800: *INTERNAL_ERROR - Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
      defaultCommon error list
      [
        {
          "code": 23,
          "message": "Missing body field",
          "description": "The field 'productionDate' is missing from posted body"
        }
      ]
    • implementation notes

      Upload a file to a specified folder or to the default folder.

      Important note: This operation requires a different host. Please use https://cloudapi.orange.com/cloud/v1 instead of https://api.orange.com/cloud/v1.

      response class (status 201)
      {
        "fileId": "string",
        "fileName": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid bearer tokenheaderstring
      Deprecated. Supported for backward compatibility only.headerstring
      (required)
      File MIME typeheaderstring
      (required)
      File name (with extension)querystring
      Target folder Idquerystring
      (required)
      File contentformDatafile
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400List of error labels:
      - INVALID_PARAMETER: A mandatory input is invalid (refer to error details). Please check your request and retry.
      - MISSING_PARAMETER: A mandatory input is missing (refer to error details). Please enrich your request and retry.
      {
        "error": {
          "code": 0,
          "label": "string",
          "details": "string"
        }
      }
      401List of error labels:
      - INVALID_TOKEN: The access_token is invalid. Please refresh the token or reauthenticate the end user if the refresh_token has expired.
      {
        "error": {
          "code": 0,
          "label": "string",
          "details": "string"
        }
      }
      403List of error labels:
      - FORBIDDEN_ACCESS: The validated scope does not authorize your application to request the resource. Please ask the end user for their consent.
      {
        "error": {
          "code": 0,
          "label": "string",
          "details": "string"
        }
      }
      404List of error labels:
      - NOT_FOUND: Resource not found. Please refer to this API Reference guide.
      {
        "error": {
          "code": 0,
          "label": "string",
          "details": "string"
        }
      }
      405List of error labels:
      - METHOD_NOT_ALLOWED: Unauthorized HTTP method for a given resource. Please refer to this API Reference guide.
      {
        "error": {
          "code": 0,
          "label": "string",
          "details": "string"
        }
      }
      500List of error labels:
      - SESSION_EXPIRED: Current session has expired. Please initialize a new session by calling the 'Init session' method.
      - TOO_BIG_FILE: The uploaded file size exceeds the authorized limit. Your application may retry the request after compressing the file or splitting it into separate files. Please inform the end user using the following message:
      -- [English]: The file you're uploading on your Cloud is too big.
      -- [French]: Le fichier que vous souhaitez sauvegarder sur votre Cloud est trop volumineux.
      - NO_SPACE_LEFT: The end user does not have enough space to store the uploaded file. You should inform the end user and may suggest deleting some files. Please inform the end user using the following message:
      -- [English]: This file cannot be uploaded: your Cloud is full.
      -- [French]: Ajout impossible : votre espace de stockage est plein
      - INTERNAL_ERROR: Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      {
        "error": {
          "code": 0,
          "label": "string",
          "details": "string"
        }
      }
      503List of error labels:
      - INTERNAL_ERROR: Internal error. Your application may retry the request. If the retry fails, please contact our support team.
      In case the request is the first one made prior to a list folder for example, and the end user has not validated its terms&condition or is not eligible to the Cloud, the error will be an 'internal error'
      {
        "error": {
          "code": 0,
          "label": "string",
          "details": "string"
        }
      }
    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
      {
        "code": 28,
        "message": "Invalid query-string parameter value",
        "description": "One or more query-string parameters contain invalid values."
      }
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
      {
        "code": 42,
        "message": "Expired credentials",
        "description": "The requested service needs credentials, and the ones provided were out-of-date."
      }
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
      {
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      }
      404List of supported error codes:
      - 60: Resource not found
      {
        "code": 60,
        "message": "Resource not found",
        "description": "The requested URI or the requested resource does not exist."
      }
      405List of supported error codes:
      - 61: Method not allowed
      {
        "code": 61,
        "message": "Method not allowed",
        "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
      }
      406List of supported error codes:
      - 62: Not acceptable
      {
        "code": 62,
        "message": "Not acceptable",
        "description": "The Accept incoming header does not match any available content-type."
      }
      408List of supported error codes:
      - 63: Request time-out
      {
        "code": 63,
        "message": "Request time-out",
        "description": "The server timed out waiting for the incoming request."
      }
      411List of supported error codes:
      - 64: Length required
      {
        "code": 64,
        "message": "Length required",
        "description": "The request did not specify a Content-Length header, which is required by the requested resource."
      }
      412List of supported error codes:
      - 65: Precondition failed
      {
        "code": 65,
        "message": "Precondition failed",
        "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
      }
      413List of supported error codes:
      - 66: Request entity too large
      {
        "code": 66,
        "message": "Request entity too large",
        "description": "The body of a request (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
      }
      414List of supported error codes:
      - 67: Request-URI too long
      {
        "code": 67,
        "message": "Request-URI too long",
        "description": "The URI provided was too long for the server to process."
      }
      415List of supported error codes:
      - 68: Unsupported Media Type
      {
        "code": 68,
        "message": "Unsupported Media Type",
        "description": "The format of the posted body is not supported by the endpoint."
      }
      500List of supported error codes:
      - 1: Internal error
      {
        "code": 1,
        "message": "internal error",
        "description": "Generic failure message, used if no more precise code can be provided."
      }
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
      {
        "code": 6,
        "message": "Orange API is over capacity, retry later !",
        "description": "The service faces too much requests and can not handle the call."
      }