Upload

---

Manages upload to OCI for the platform.

Upload an image/document for the group

Use this endpoint to upload an image or document for the group. All the uploads goes to an OCI Bucket

Request

Endpoint

PUT /api/v01/draas/{draas_instance}/groups/{uuid}/upload_documents

Authorization

Required role

groups.instance.upload_documents

Path Parameters

Parameter	Type	Description
draas_instance	string	See common parameters
uuid	string	A system generated unique ID (UUID) identifying the group for which you want to add or modify properties

URL/Query parameters

N/A

Body

The body needs to be a multipart-form-data with the following fields:

Parameter	Type	Description
file	File	The file object that needs to be uploaded
type	string	The type of document you want to upload. Could be image or document
kind	string	The kind of document you want to upload. This restricts the uploaded documents. The kind depends on the type above. type: document loa guide type: image favicon login.bg login.logo main.bg main.logo

Response

Status codes

Parameter	Description
200	The documents were successfully uploaded
400	Error while processing the properties
500	Uncatched error on server side

Success

Body

Parameter	Type	Description	Conditional?
obj_ref	string	This is a relative path of the uploaded resource on OCI	no
obj_url	string	This is the full URL targeting the resource on OCI	no

Example

{
  "obj_ref": "groups/1234-afd3443ff-111010d/images/login_bg.png",
  "obj_url": "https://objectstorage.eu-amsterdam-1.oraclecloud.com/.../groups/1234-afd3443ff-111010d/images/login_bg.png"
}