Account View
Returns the account information
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account
Response samples
- 200
- default
{- "id": "324234523452345",
- "username": "johndoe",
- "email": "john.doe@evecloud.xyz",
- "badges": [ ],
- "billing": {
- "plan": "hobby",
- "name": "John Doe",
- "phone": "+49123456789",
- "trial_available": true,
- "period": {
- "start": "2020-01-01",
- "end": "2020-01-01"
}, - "trial": {
- "start": "2020-01-01",
- "end": "2020-01-01"
}, - "cancelation": "2020-01-01",
- "address": {
- "line1": "Musterstraße 1",
- "line2": "Musterstraße 1",
- "city": "Musterstadt",
- "postal_code": "12345",
- "state": "Musterland",
- "country": "Germany"
}, - "status": "active"
}, - "usage": {
- "projects": 1,
- "vcpu": 1,
- "memory": 1024,
- "storage": 1024
}, - "verifications": {
- "email": true,
- "phone": true
}, - "active_since": "2019-01-01T00:00:00.000Z"
}
Account Update
Updates the account information
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
name | string The name of this account. |
line1 | string The first line of the address. |
line2 | string The second line of the address. |
city | string The city of the billing contact. |
state | string The state of the billing contact. |
postal_code | string The postal code of the billing contact. |
country | string The country of the billing contact. |
Responses
Request samples
- Payload
- SHELL
{- "name": "John",
- "line1": "123 Main Street",
- "line2": "123 Main Street",
- "city": "Houston",
- "state": "Texas",
- "postal_code": "10001",
- "country": "US"
}
Response samples
- 200
- default
{- "id": "324234523452345",
- "username": "johndoe",
- "email": "john.doe@evecloud.xyz",
- "badges": [ ],
- "billing": {
- "plan": "hobby",
- "name": "John Doe",
- "phone": "+49123456789",
- "trial_available": true,
- "period": {
- "start": "2020-01-01",
- "end": "2020-01-01"
}, - "trial": {
- "start": "2020-01-01",
- "end": "2020-01-01"
}, - "cancelation": "2020-01-01",
- "address": {
- "line1": "Musterstraße 1",
- "line2": "Musterstraße 1",
- "city": "Musterstadt",
- "postal_code": "12345",
- "state": "Musterland",
- "country": "Germany"
}, - "status": "active"
}, - "usage": {
- "projects": 1,
- "vcpu": 1,
- "memory": 1024,
- "storage": 1024
}, - "verifications": {
- "email": true,
- "phone": true
}, - "active_since": "2019-01-01T00:00:00.000Z"
}
Personal Access Token List
Returns the list of personal access tokens
query Parameters
page | integer <int32> Default: 1 The page of a collection to return. |
limit | integer <int32> Default: 100 The number of items to return per page. |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/tokens
Response samples
- 200
- default
{- "data": [
- {
- "id": "fe3f-e8c7-4e5e-b2e4-8f4662b6bfa3",
- "label": "Example",
- "created_at": "2019-01-01T00:00:00.000Z",
- "last_used": "2019-01-01T00:00:00.000Z"
}
], - "meta": {
- "page": 1,
- "limit": 100,
- "total": 1
}
}
Personal Access Token Create
Creates a new personal access token
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
label | string The label for the personal access token |
Responses
Request samples
- Payload
- SHELL
{- "label": "My Token"
}
Response samples
- 200
- default
{- "id": "12e32f3e-f3f3-4f4f-f4f4-f4f4f4f4f4f4",
- "label": "My Token",
- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpeJf36POk6yJV_adQssw5c"
}
Personal Access Token Update
Updates an existing personal access token
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
id | string The personal access token ID |
label | string The label for the personal access token |
Responses
Request samples
- Payload
- SHELL
{- "id": "12e32f3e-f3f3-4f4f-f4f4-f4f4f4f4f4f4",
- "label": "New Label"
}
Response samples
- 200
- default
{- "message": "Person Access Token updated."
}
Personal Access Token Delete
Deletes an existing personal access token
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
id | string The personal access token ID |
Responses
Request samples
- Payload
- SHELL
{- "id": "12e32f3e-f3f3-4f4f-f4f4-f4f4f4f4f4f4"
}
Response samples
- 200
- default
{- "message": "Person Access Token deleted."
}
Personal Access Token View
Returns the personal access token information
path Parameters
tokenID required | string The token ID |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/tokens/c27aa721-c083-406c-9f27-13a026468a46
Response samples
- 200
- default
{- "id": "fe3f-e8c7-4e5e-b2e4-8f4662b6bfa3",
- "label": "Example",
- "created_at": "2019-01-01T00:00:00.000Z",
- "last_used": "2019-01-01T00:00:00.000Z"
}
Invoice List
Returns a list of invoices for the account
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/invoices
Response samples
- 200
- default
{- "data": [
- {
- "id": "in_1LSHd6Be5KiwCS6emSkUL9yZ",
- "identifier": "INV-0001",
- "label": "invoice",
- "status": "paid",
- "subtotal": 100,
- "tax": 20,
- "total": 120,
- "created": "2019-01-01T00:00:00.000Z"
}
]
}
Invoice View
Returns the details of an invoice
path Parameters
invoiceID required | string The invoice ID |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/invoices/in_1LSHd6Be5KiwCS6emSkUL9yZ
Response samples
- 200
- default
{- "data": {
- "id": "in_1LSHd6Be5KiwCS6emSkUL9yZ",
- "identifier": "INV-0001",
- "label": "invoice",
- "status": "paid",
- "subtotal": 100,
- "tax": 20,
- "total": 120,
- "created": "2019-01-01T00:00:00.000Z"
}
}
Payment Methods List
Returns a list of payment methods for the account
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/payment-methods
Response samples
- 200
- default
{- "data": [
- {
- "id": "pm_1LSHd6Be5KiwCS6eQZ5Z5Z5Z",
- "card": {
- "brand": "visa",
- "last4": "4242",
- "expires": "01/2020"
}, - "default": true,
- "type": "credit",
- "created": "2019-01-01T00:00:00.000Z"
}
], - "meta": {
- "page": 1,
- "limit": 100,
- "total": 1
}
}
Payment Method View
Returns the details of a payment method
path Parameters
paymentID required | string The payment method ID |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/payment-methods/pm_1LSHd6Be5KiwCS6eZ0ZQZ2Zj
Response samples
- 200
- default
{- "data": {
- "id": "pm_1LSHd6Be5KiwCS6eQZ5Z5Z5Z",
- "card": {
- "brand": "visa",
- "last4": "4242",
- "expires": "01/2020"
}, - "default": true,
- "type": "credit",
- "created": "2019-01-01T00:00:00.000Z"
}
}
Payment Method Delete
Deletes a payment method
path Parameters
paymentID required | string The payment method ID |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X DELETE -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/payment-methods/pm_1LSHd6Be5KiwCS6eZ0ZQZ2Zj
Response samples
- 200
- default
{- "message": "Successfully deleted payment method."
}
Payment Method Make Default
Sets the payment method as the default for the account
path Parameters
paymentID required | string The payment method ID |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X POST -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/payment-methods/pm_1LSHd6Be5KiwCS6eZ0ZQZ2Zj/make-default
Response samples
- 200
- default
{- "message": "Successfully updated default payment method."
}
Login List
List all account logins
query Parameters
page | integer <int32> Default: 1 The page of a collection to return. |
limit | integer <int32> Default: 100 The number of items to return per page. |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/logins
Response samples
- 200
- default
{- "data": [
- {
- "id": "681edf73-f45d-47be-8ba3-86c526f459b8",
- "ip": "192.0.0.0",
- "date": "2019-01-01T00:00:00.000Z"
}
], - "meta": {
- "page": 1,
- "limit": 100,
- "total": 1
}
}
Login View
Get Login information
path Parameters
loginID required | string The login ID |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/logins/681edf73-f45d-47be-8ba3-86c526f459b8
Response samples
- 200
- default
{- "id": "681edf73-f45d-47be-8ba3-86c526f459b8",
- "ip": "192.0.0.0",
- "date": "2019-01-01T00:00:00.000Z"
}
Event List
List all account events
query Parameters
page | integer <int32> Default: 1 The page of a collection to return. |
limit | integer <int32> Default: 100 The number of items to return per page. |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/events
Response samples
- 200
- default
{- "data": [
- {
- "id": "681edf73-f45d-47be-8ba3-86c526f459b8",
- "action": "account_update",
- "message": "Your account settings have been updated.",
- "date": "2019-01-01T00:00:00.000Z"
}
], - "meta": {
- "page": 1,
- "limit": 100,
- "total": 1
}
}
Event View
Get Event information
path Parameters
eventID required | string The event ID |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/events/681edf73-f45d-47be-8ba3-86c526f459b8
Response samples
- 200
- default
{- "id": "681edf73-f45d-47be-8ba3-86c526f459b8",
- "action": "account_update",
- "message": "Your account settings have been updated.",
- "date": "2019-01-01T00:00:00.000Z"
}
Preferences View
Get account preferences
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/account/preferences
Response samples
- 200
- default
{- "darkmode": true,
- "notifications": true
}
Preferences Update
Update account preferences
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
darkmode | boolean Enable or disable darkmode |
notifications | boolean Enable or disable notifications |
Responses
Request samples
- Payload
- SHELL
{- "darkmode": false,
- "notifications": true
}
Response samples
- 200
- default
{- "message": "Preferences updated."
}
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects
Response samples
- 200
- default
[- {
- "data": [
- {
- "id": "0524q712",
- "uuid": "681edf73-f45d-47be-8ba3-86c526f459b8",
- "label": "Example",
- "status": "active",
- "owner": true,
- "network": {
- "domain": {
- "url": "zwsqwjmg.evecloudcontainers.com",
- "private": false
}, - "region": "us-central"
}, - "image": "registry.evecloud.xyz/images/nodejs:18",
- "limits": {
- "vcpus": 1,
- "memory": 1024,
- "storage": 1024
}, - "created_at": "2019-01-01T00:00:00.000Z",
- "updated_at": "2019-01-01T00:00:00.000Z"
}
], - "meta": {
- "page": 1,
- "limit": 100,
- "total": 1
}
}
]
Project Create
Create a new project
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
label | string The label of the Project |
memory | number The amout of memory to allocate to the project |
storage | number The amout of storage to allocate to the project |
region | string The region to create the project in |
image | number The image id to use for the project |
git | string The git repository to clone. (optional) |
domain | string The custom domain to use for the project (optional) |
Responses
Request samples
- Payload
- SHELL
{- "label": "My Project",
- "memory": 1024,
- "storage": 1024,
- "region": "eu-central",
- "image": 32,
- "domain": "my-project.com"
}
Response samples
- 200
- default
{- "message": "Project created."
}
Project View
Get a Project
path Parameters
projectID required | string The ID of the Project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712
Response samples
- 200
- default
{- "id": "0524q712",
- "uuid": "681edf73-f45d-47be-8ba3-86c526f459b8",
- "label": "Example",
- "status": "active",
- "owner": true,
- "network": {
- "domain": {
- "url": "zwsqwjmg.evecloudcontainers.com",
- "private": false
}, - "region": "us-central"
}, - "image": "registry.evecloud.xyz/images/nodejs:18",
- "limits": {
- "vcpus": 1,
- "memory": 1024,
- "storage": 1024
}, - "created_at": "2019-01-01T00:00:00.000Z",
- "updated_at": "2019-01-01T00:00:00.000Z"
}
Project Update
Update a Project
Authorizations:
path Parameters
projectID required | string The ID of the Project |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
label | string The label of the Project |
memory | number The amout of memory to allocate to the project |
storage | number The amout of storage to allocate to the project |
Responses
Request samples
- Payload
- SHELL
{- "label": "My Project",
- "memory": 1024,
- "storage": 1024
}
Response samples
- 200
- default
{- "message": "Project updated."
}
Project Delete
Delete a Project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X DELETE -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712
Response samples
- 200
- default
{- "message": "Project deleted."
}
Resources View
Get the resources of a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/resources
Response samples
- 200
- default
{- "status": "running",
- "resources": {
- "memory_bytes": 1024,
- "cpu_absolute": 0.5,
- "disk_bytes": 1024,
- "network_rx_bytes": 1024,
- "network_tx_bytes": 1024
}
}
Websocket View
Get the websocket of a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/websocket
Response samples
- 200
- default
{- "socket": "wss://vma02.evecloud.xyz:8443/api/servers/3cc9e05e-7a44-461b-99ef-cd626a647861/ws",
- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
Project Start
Start a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X POST -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/boot
Response samples
- 200
- default
{- "message": "Project is starting."
}
Project Shutdown
Shutdown a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X POST -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/shutdown
Response samples
- 200
- default
{- "message": "Project is shutting down."
}
Project Restart
Restart a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X POST -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/restart
Response samples
- 200
- default
{- "message": "Project is restarting."
}
Project Reinstall
Reinstall a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X POST -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/reinstall
Response samples
- 200
- default
{- "message": "Project is reinstalling."
}
Backup List
Get a list of backups for a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/backups
Response samples
- 200
- default
{- "data": [
- {
- "uuid": "681edf73-f45d-47be-8ba3-86c526f459b8",
- "name": "backup-2019-01-01-00-00-00",
- "size": 100,
- "created_at": "2019-01-01T00:00:00.000Z",
- "finished_at": "2019-01-01T00:00:00.000Z"
}
], - "meta": {
- "page": 1,
- "limit": 100,
- "total": 1
}
}
Backup Create
Create a backup for a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
name | string The name of the backup |
Responses
Request samples
- Payload
- SHELL
{- "name": "My Backup"
}
Response samples
- 200
- default
{- "message": "Backup is being created."
}
Backup View
View a backup
path Parameters
projectID required | string The ID of the project |
uuid required | string The UUID of the backup |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/backups/0524q712
Response samples
- 200
- default
{- "uuid": "681edf73-f45d-47be-8ba3-86c526f459b8",
- "name": "backup-2019-01-01-00-00-00",
- "size": 100,
- "created_at": "2019-01-01T00:00:00.000Z",
- "finished_at": "2019-01-01T00:00:00.000Z"
}
Backup Delete
Delete a backup
path Parameters
projectID required | string The ID of the project |
uuid required | string The UUID of the backup |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X DELETE -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/backups/0524q712
Response samples
- 200
- default
{- "message": "Backup is being deleted."
}
Backup Download
Download a backup
path Parameters
projectID required | string The ID of the project |
uuid required | string The UUID of the backup |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/backups/0524q712/download
Response samples
- 200
- default
Config View
View the config of a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/config
Response samples
- 200
- default
{- "environment": [
- {
- "name": "EveCloud API URL",
- "description": "The URL of the EVECloud API.",
- "key": "EVECLOUD_API_URL",
- "editable": true,
- "rules": "required|url"
}
], - "image": "registry.evecloud.xyz/images/nodejs:18"
}
Config Update
Update the config of a project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
key | string The key of the config |
value | string The value of the config |
Responses
Request samples
- Payload
- SHELL
{- "key": "MAIN_FILE",
- "value": "index.js"
}
Response samples
- 200
- default
{- "message": "Environment variable has been updated."
}
Image List
List all versions of the image installed on the project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/images
Response samples
- 200
- default
{- "versions": [
- "registry.evecloud.xyz/images/nodejs:18"
]
}
Image Update
Update the image version installed on the project
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
image | string The image version to install |
Responses
Request samples
- Payload
- SHELL
{- "image": "registry.evecloud.xyz/images/nodejs:18"
}
Response samples
- 200
- default
{- "message": "Image version has been updated."
}
File List
List all files in a directory
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory to list |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/files/list
Response samples
- 200
- default
{- "data": {
- "key": "dir",
- "name": "lib",
- "mode": "drwxr-xr-x",
- "modeBits": "755",
- "size": 4096,
- "isFile": false,
- "isSymlink": false,
- "isArchiveType": false,
- "isEditable": false,
- "mimetype": "inode/directory",
- "created_at": "2019-01-01T00:00:00.000Z",
- "modified_at": "2019-01-01T00:00:00.000Z"
}
}
File Rename
Rename a file
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory to list |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
file | string The old file name |
name | string The new file name |
Responses
Request samples
- Payload
- SHELL
{- "file": "index.js",
- "name": "index2.js"
}
Response samples
- 200
- default
{- "message": "File renamed."
}
File Write
Write a file
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory to list |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
file | string The file name |
content | string The file content |
Responses
Request samples
- Payload
- SHELL
{- "file": "index.js",
- "content": "console.log(\"Hello World!\");"
}
Response samples
- 200
- default
{- "message": "File saved."
}
File Upload
Upload a file
NOTE: for directory see https://i.imgur.com/kv17w6o.png.
path Parameters
projectID required | string The ID of the project |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/files/upload
Response samples
File Download
Download a file
path Parameters
projectID required | string The ID of the project |
query Parameters
file required | string The file to download |
dir | string Default: "/" The directory of the file |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/files/download?file=index.js
Response samples
File Contents
Get the contents of a file
path Parameters
projectID required | string The ID of the project |
query Parameters
file required | string The file to get the contents of |
dir | string Default: "/" The directory of the file |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/v1/projects/0524q712/files/contents?file=index.js
Response samples
- 200
- default
"console.log(\"Hello World!\");"
Delete File
Delete a file
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory of the file |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
files | Array of arrays The files to delete |
Responses
Request samples
- Payload
- SHELL
{- "files": "index.js"
}
Response samples
- 200
- default
{- "message": "Files deleted."
}
Decompress File
Decompress a file
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory of the file |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
file | string The file to decompress |
Responses
Request samples
- Payload
- SHELL
{- "file": "archive.zip"
}
Response samples
- 200
- default
{- "message": "File decompressed."
}
Compress Files
Compress files
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory of the files |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
files | Array of arrays The files to compress |
Responses
Request samples
- Payload
- SHELL
{- "files": "index.js"
}
Response samples
- 200
- default
{- "message": "Files compressed."
}
Create Folder
Create a folder
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory of the folder |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
name | string The folder name |
Responses
Request samples
- Payload
- SHELL
{- "name": "folder"
}
Response samples
- 200
- default
{- "message": "Folder created."
}
Copy File
Copy file
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory of the file |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
file | string The file to copy |
Responses
Request samples
- Payload
- SHELL
{- "file": "index.js"
}
Response samples
- 200
- default
{- "message": "File copied."
}
Chmod File
Change file permissions
path Parameters
projectID required | string The ID of the project |
query Parameters
dir | string Default: "/" The directory of the file |
header Parameters
Authorization required | string Bearer token |
Request Body schema: application/json
file | string The file to change permissions |
perm | string The permissions to set |
Responses
Request samples
- Payload
- SHELL
{- "file": "index.js",
- "perm": "777"
}
Response samples
- 200
- default
{- "message": "File permissions changed."
}
Image List
Get the avaliable images
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/images
Response samples
- 200
- default
{- "data": [
- {
- "id": 32,
- "name": "nodejs",
- "description": "NodeJS",
- "author": "support@evecloud.xyz",
- "latest": "registry.evecloud.xyz/images/nodejs:18",
- "versions": [
- "registry.evecloud.xyz/images/nodejs:18"
], - "created_at": "2019-01-01T00:00:00Z",
- "updated_at": "2019-01-01T00:00:00Z"
}
], - "meta": {
- "page": 1,
- "limit": 100,
- "total": 1
}
}
Image View
Get the details of an image
path Parameters
id required | string The ID of the image |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/images/42
Response samples
- 200
- default
{- "id": 32,
- "name": "nodejs",
- "description": "NodeJS",
- "author": "support@evecloud.xyz",
- "latest": "registry.evecloud.xyz/images/nodejs:18",
- "versions": [
- "registry.evecloud.xyz/images/nodejs:18"
], - "created_at": "2019-01-01T00:00:00Z",
- "updated_at": "2019-01-01T00:00:00Z"
}
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/regions
Response samples
- 200
- default
[- {
- "id": "us-central",
- "location": {
- "country": "us",
- "city": "missouri",
- "coords": [
- "38.57",
- "-92.15"
]
}, - "status": "online"
}
]
Region View
Get information about a region
path Parameters
id required | string The ID of the region |
header Parameters
Authorization required | string Bearer token |
Responses
Request samples
- SHELL
curl -X GET -H "Authorization: Bearer $TOKEN" https://api.evecloud.xyz/regions/us-central
Response samples
- 200
- default
{- "id": "us-central",
- "location": {
- "country": "us",
- "city": "missouri",
- "coords": [
- "38.57",
- "-92.15"
]
}, - "status": "online"
}