UCF Projects

Create a ucf project

POST https://api-v2.acrcloud.com/api/ucf-projects

This endpoint allows you to get free cakes.

Headers

NameTypeDescription

Authorization

string

Bearer token

Request Body

NameTypeDescription

name

string

The project name

type

string

BM or FILES, default is BM.

region

string

eu-west-1,us-west-2,ap-southeast-1

config

object

default is {"days":3,"mini_ms":5000,"max_ms":300000}

{
    "data": {
        "uid": 1,
        "name": "test",
        "region": "eu-west-1",
        "type": "BM",
        "config": {
            "days": 3,
            "min_ms": 5000,
            "max_ms": 300000
        },
        "updated_at": "2020-12-28T04:57:13.000000Z",
        "created_at": "2020-12-28T04:57:13.000000Z",
        "id": 100000
    }
}
curl --location --request POST 'http://127.0.0.1:8080/api/ucf-projects' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer token' \
--header 'Content-Type: application/json' \
--data-raw '{"name":"test", "region":"eu-west-1", "type":"BM"}'

List the ucf projects

GET https://api-v2.acrcloud.com/api/ucf-projects

Query Parameters

NameTypeDescription

region

string

Headers

NameTypeDescription

Authorization

string

Bearer token

{
    "data": [
        {
            "id": 100000,
            "uid": 1,
            "name": "test",
            "region": "eu-west-1",
            "type": "BM",
            "config": {
                "days": 3,
                "min_ms": 5000,
                "max_ms": 300000
            },
            "created_at": "2020-12-28T04:57:13.000000Z",
            "updated_at": "2020-12-28T04:57:13.000000Z"
        }
    ],
    "links": {
        "first": "http://127.0.0.1:8080/api/ucf-projects?page=1",
        "last": "http://127.0.0.1:8080/api/ucf-projects?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://127.0.0.1:8080/api/ucf-projects",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}
curl --location --request GET 'http://127.0.0.1:8080/api/ucf-projects' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer token'

Update a ucf project

PUT https://api-v2.acrcloud.com/api/ucf-projects/:id

Path Parameters

NameTypeDescription

id

number

the ucf project id

Headers

NameTypeDescription

Authorization

string

Bearer token

Request Body

NameTypeDescription

config

object

name

string

{
    "data": {
        "uid": 1,
        "name": "test",
        "region": "eu-west-1",
        "type": "BM",
        "config": {
            "days": 3,
            "min_ms": 5000,
            "max_ms": 300000
        },
        "updated_at": "2020-12-28T04:57:13.000000Z",
        "created_at": "2020-12-28T04:57:13.000000Z",
        "id": 100000
    }
}

Delete a ucf project

DELETE /api/ucf-projects/:id

Path Parameters

NameTypeDescription

id

number

The ucf project id

Headers

NameTypeDescription

Authorization

string

Bearer token

Last updated