API Documentation

The EDJX API is based on HTTPS requests and JSON responses. These APIs are organized into a collection of endpoints that allow the manipulation of EDJX resources.

To use EDJX APIs, call Login API with your credentials to receive the Authentication token. Use this token in headers to call other EDJX APIs.


Authentication


Users require authentication to signup and log in to the EDJX platform.

POST Login

Logs into the EDJX Platform.

Body Params

Body Params Description Type Required Format
email Valid login email address string Yes
password Valid login password string Yes
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length2424
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 08:37:57 GMT
EtagW/"978-8i19Q4T+JDk6S94K8o+8DTGH9Mc"
ServerEDJX
Traceparent00-d0177c44fd6c058f98c904913085ecf6-7e8683f88197ed0d-01
X-Corelation-Idd0177c44fd6c058f98c904913085ecf6
X-Powered-ByExpress
Sample request
Login
curl -X POST -H "Content-Type: application/json" -d '{
	"email": "foo@example.com",
	"password": "aVeryStrongPassword!"
}' "https://api.edjx.net/guest/login"
POST /guest/login HTTP/1.1
Host: api.edjx.net
Content-Type: application/json

{
	"email": "foo@example.com",
	"password": "aVeryStrongPassword!"
}
{
    "id": "9000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "name": "John",
    "email": "foo@example.com",
    "username": "John_roy",
    "phone": "",
    "mobileNumber": "",
    "address": "",
    "city": "",
    "state": "",
    "areaCode": "",
    "country": "",
    "isGoogle": false,
    "status": "active",
    "photoUrl": "https://www.gravatar.com/avatar/044674887624f209a3fb70fc7be6c8d4?default=identicon",
    "timezone": 0,
    "timezoneLocation": "UTC",
    "updatedAt": "2022-11-07T08:02:06.060Z",
    "createdAt": "2022-11-07T08:02:06.000Z",
    "isPasswordSet": true,
    "organizations": [
        {
            "id": "000g0000-0a0b-0a0d-bbbb-0000000h0001",
            "name": "MYORG",
            "limits": null,
            "privateKey": null,
            "letsEncryptKid": null,
            "website": null,
            "taxId": null,
            "paymentAccountId": null,
            "paymentCustomerId": null,
            "defaultPaymentMethodId": null,
            "subscriptionId": null,
            "subscriptionUpdatedAt": null,
            "subscriptionCreatedAt": null,
            "status": "inactive",
            "createdBy": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "updatedBy": null,
            "createdAt": "2022-11-07T08:02:06.244Z",
            "updatedAt": "2022-11-07T08:02:06.244Z",
            "primaryOrg": true
        }
    ],
    "token": "TOKEN",
    "refreshToken": "REFRESH-TOKEN",
    "isBecomeSessionActive": false,
    "becomer": "",
    "activities": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0100/activities",
        "rel": [
            "collection"
        ]
    },
    "recents": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0010/recents",
        "method": "GET",
        "rel": [
            "collection"
        ]
    }
}

POST Refresh Token

Generates a new token.

Body Params

Body Params Description Type Required Format
Token Tokens are issued to third-party clients by an authorization server with the approval of the resource owner. The client uses the access token to access the protected resources hosted by the resource server. string Yes
Refresh Token Refresh Tokens are credentials used to obtain access tokens. These tokens are issued to the client by the authorization server. The tokens are used to obtain a new access token when the current access token becomes invalid or expires or to obtain additional access tokens with an identical or narrower scope. string No
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length620
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 08:04:25 GMT
EtagW/"26c-oPr0L6hSXSkrOPklC+J85p6n5hE"
ServerEDJX
Traceparent00-e4fe95fb8a6ee36542f0dc7c1239b837-116d5a0116209373-01
X-Corelation-Ide4fe95fb8a6ee36542f0dc7c1239b837
X-Powered-ByExpress
Sample request
Refresh Token
curl -X POST -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
    "token" : "TOKEN",
	"refreshToken": "REFRESH-TOKEN"
}' "https://api.edjx.net/refresh"
POST /refresh HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Content-Type: application/json

{
    "token" : "TOKEN",
	"refreshToken": "REFRESH-TOKEN"
}
{
    "token": "TOKEN"
}

POST Auth Status

Checks the user authentication status.

Body Params

Body Params Description Type Required Format
email Valid email address string Yes
token Valid authentication token string Yes
Content-Typeapplication/json
Acceptapplication/ion+json
Status201
Access-Control-Allow-Origin*
Content-Length17
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 08:25:15 GMT
EtagW/"11-44NV+bMZaNQ4k78GEbtx8X41Bi8"
ServerEDJX
Traceparent00-5079076d62b1d5978d70f3aa35694050-bb8f3a75672ceb0c-01
X-Corelation-Id5079076d62b1d5978d70f3aa35694050
X-Powered-ByExpress
Sample request
Auth Status
curl -X POST -H "Content-Type: application/json" -H "Accept: application/ion+json" -d '{
	"email": "foo@example.com",
	"token": "TOKEN"
}' "https://api.edjx.net/guest/auth-status"
POST /guest/auth-status HTTP/1.1
Host: api.edjx.net
Content-Type: application/json
Accept: application/ion+json

{
	"email": "foo@example.com",
	"token": "TOKEN"
}
{
    "loggedIn": true
}

POST Logout

Logs out the user from the EDJX Platform and removes any stored tokens.

AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length16
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 08:24:45 GMT
EtagW/"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA"
ServerEDJX
Traceparent00-c379218ee4d7e2d949fc323b2548353f-7977d1a82b7def17-01
X-Corelation-Idc379218ee4d7e2d949fc323b2548353f
X-Powered-ByExpress
Sample request
Logout
curl -X POST -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/auth/logout"
POST /api/auth/logout HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "success": true
}

POST Logout All

Logs out the user from all devices on the EDJX Platform and removes any stored tokens.

AuthorizationBearer TOKEN
Status201
Access-Control-Allow-Origin*
Content-Length16
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 08:25:46 GMT
EtagW/"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA"
ServerEDJX
Traceparent00-a59b1a8802d98d156a7ff5a227179794-e9c63ef68dc26dab-01
X-Corelation-Ida59b1a8802d98d156a7ff5a227179794
X-Powered-ByExpress
Sample request
Logout All
curl -X POST -H "Authorization: Bearer TOKEN" "https://api.edjx.net/api/auth/logout-all"
POST /api/auth/logout-all HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
{
    "success": true
}

Organizations


Gets details on organization, number of applications, number of domains, number of buckets, and so on.

POST Create Organization

Creates an organization in the EDJX Platform.

Body Params

Body Params Description Type Required Format
name Unique organization name string Yes Minimum 2 characters are required
taxId TaxId of your organisation string No
Content-Typeapplication/json
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Status201
Access-Control-Allow-Origin*
Content-Length2291
Content-Typeapplication/json; charset=utf-8
DateTue, 08 Nov 2022 05:02:22 GMT
EtagW/"8f3-NmGjEkR2x82WwLpgVBNCXkVNgE8"
ServerEDJX
Traceparent00-098f1cd9f3f1eae7270cf4e312ffdeec-6e9a0729aee75a4c-01
X-Corelation-Id098f1cd9f3f1eae7270cf4e312ffdeec
X-Powered-ByExpress
Sample request
Create Organization
curl -X POST -H "Content-Type: application/json" -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -d '{
	"name": "MyFirstOrg"
}' "https://api.edjx.net/api/organizations"
POST /api/organizations HTTP/1.1
Host: api.edjx.net
Content-Type: application/json
Accept: application/ion+json
Authorization: Bearer TOKEN

{
	"name": "MyFirstOrg"
}
{
    "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
    "id": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "name": "MyFirstOrg",
    "taxId": null,
    "paymentAccountId": null,
    "paymentCustomerId": null,
    "defaultPaymentMethodId": null,
    "website": null,
    "subscriptionId": null,
    "subscriptionUpdatedAt": null,
    "subscriptionCreatedAt": null,
    "status": "inactive",
    "limits": {
        "maxApplicationsPerOrg": 50,
        "maxFunctionsPerApp": 100,
        "maxBucketsPerOrg": 20,
        "maxFilesPerBucket": 100,
        "maxDomainsPerOrg": 10,
        "maxRecordsPerDomain": 50,
        "maxRulesPerDomain": 50,
        "maxCertificatesPerDomain": 50,
        "maxNodesPerOrg": 1000,
        "maxCertificatesPerNode": 50,
        "maxUsersPerOrg": 50
    },
    "users": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users",
        "method": "GET"
    },
    "createdBy": "000g0000-0a0b-0a0d-bbbb-0000000h01200",
    "createdAt": "2022-11-08T05:02:21.943Z",
    "updatedAt": "2022-11-08T05:02:21.943Z",
    "update": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "taxId",
                "label": "Tax Id",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "website",
                "label": "Website",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?organization=374c1c04-5748-40cb-989a-ca1a389de33f",
        "method": "GET"
    },
    "addresses": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/addresses",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "paymentMethods": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/paymentMethods",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "transactions": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/transactions",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "currentSubscription": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/currentSubscription",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "additionalUsage": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/additionalUsage",
        "method": "GET",
        "rel": [
            "collection"
        ]
    }
}

GET Read All Organizations

Gets the details of all organizations associated with the user.

AuthorizationBearer TOKEN
Content-Typeapplication/json
Acceptapplication/ion+json
Status200
Access-Control-Allow-Origin*
Content-Length33637
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 17:41:54 GMT
EtagW/"8365-t/Z81P0UhJ/9nDqbSlbTwY2CJco"
ServerEDJX
Traceparent00-038ad0d443419e52f4dccb2281ef33d9-d7df213d040a71f5-01
X-Corelation-Id038ad0d443419e52f4dccb2281ef33d9
X-Powered-ByExpress
Sample request
Read All Organizations
curl -X GET -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -H "Accept: application/ion+json" "https://api.edjx.net/api/organizations"
GET /api/organizations HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Content-Type: application/json
Accept: application/ion+json
{
    "self": {
        "href": "https://api.edjx.net/api/organizations",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 1,
    "first": {
        "href": "https://api.edjx.net/api/organizations?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": {
        "href": "https://api.edjx.net/api/organizations?page=2",
        "rel": [
            "collection"
        ]
    },
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/organizations?page=4",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
            "id": "374c1c04-5748-40cb-989a-ca1a389de33f",
            "name": "MyFirstOrg",
            "taxId": "",
            "currency": "usd",
            "paymentAccountId": "",
            "paymentCustomerId": "",
            "defaultPaymentMethodId": "",
            "invoiceAddress": {
                "id": "0c4b600e-007d-02ec-0300-592b7e972e00",
                "name": "John",
                "country": "AL",
                "state": "BDG",
                "city": "city",
                "areaCode": "110063",
                "mobileNumber": "1234567890",
                "phoneNumber": "1234567890",
                "email": "foo@example.com",
                "address": "New York Street 2"
            },
            "shippingAddress": {
               "id": "1c4b605e-067d-02ec-0300-592b7e972e09",
                "name": "John",
                "country": "AL",
                "state": "BDG",
                "city": "city",
                "areaCode": "110063",
                "mobileNumber": "1234567890",
                "phoneNumber": "1234567890",
                "email": "foo@example.com",
                "address": "New York Street 2"
            },
            "website": "",
            "subscriptionId": "",
            "subscriptionUpdatedAt": null,
            "subscriptionCreatedAt": null,
            "status": "inactive",
            "limits": {
                "maxApplicationsPerOrg": 50,
                "maxFunctionsPerApp": 100,
                "maxBucketsPerOrg": 20,
                "maxFilesPerBucket": 10000,
                "maxDomainsPerOrg": 10,
                "maxRecordsPerDomain": 50,
                "maxRulesPerDomain": 50,
                "maxCertificatesPerDomain": 50,
                "maxNodesPerOrg": 1000,
                "maxCertificatesPerNode": 50,
                "maxUsersPerOrg": 50
            },
            "primaryOrg": false,
            "applications": {
                "size": 1,
                "href": "https://api.edjx.net/api/applications?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
            },
            "nodes": {
                "size": 0,
                "href": "https://api.edjx.net/api/nodes?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
            },
            "buckets": {
                "size": 1,
                "href": "https://api.edjx.net/api/buckets?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
            },
            "domains": {
                "size": 1,
                "href": "https://api.edjx.net/api/domains?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
            },
            "users": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users",
                "method": "GET"
            },
            "createdBy": {
                "id": "fc4b670e-527d-42ec-9300-592b7e972e28"
            },
            "createdAt": "2022-10-03T11:42:59.755Z",
            "updatedAt": "2022-10-03T11:42:59.755Z",
            "update": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "taxId",
                        "label": "Tax Id",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "website",
                        "label": "Website",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": false
                    }
                ]
            },
            "activities": {
                "href": "https://api.edjx.net/api/activities?organization=374c1c04-5748-40cb-989a-ca1a389de33f",
                "method": "GET"
            },
            "addresses": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/addresses",
                "method": "GET",
                "rel": [
                    "collection"
                ]
            },
            "paymentMethods": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/paymentMethods",
                "method": "GET",
                "rel": [
                    "collection"
                ]
            },
            "transactions": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/transactions",
                "method": "GET",
                "rel": [
                    "collection"
                ]
            },
            "currentSubscription": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/currentSubscription",
                "method": "GET",
                "rel": [
                    "collection"
                ]
            },
            "additionalUsage": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/additionalUsage",
                "method": "GET",
                "rel": [
                    "collection"
                ]
            }
        }
    ],
    "create": {
        "href": "https://api.edjx.net/api/organizations",
        "rel": [
            "create-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "taxId",
                "label": "Tax Id",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "website",
                "label": "Website",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    }
}

GET Read Organization

Gets the details of a specific organization.

AuthorizationBearer TOKEN
Content-Typeapplication/json
Acceptapplication/ion+json
Status200
Access-Control-Allow-Origin*
Content-Length3217
Content-Typeapplication/json; charset=utf-8
DateTue, 08 Nov 2022 05:04:34 GMT
EtagW/"c91-6nhUSZPH3N0Ox+yrKhpXt9TPXro"
ServerEDJX
Traceparent00-0d80c5bac4a01d746621e524a7f3fe97-e4604f744b248137-01
X-Corelation-Id0d80c5bac4a01d746621e524a7f3fe97
X-Powered-ByExpress
Sample request
Read Organization
curl -X GET -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -H "Accept: application/ion+json" "https://api.edjx.net/api/organizations/:organizationId"
GET /api/organizations/:organizationId HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Content-Type: application/json
Accept: application/ion+json
{
    "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
    "id": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "name": "MyFirstOrg",
    "taxId": "",
    "currency": "usd",
    "paymentAccountId": "",
    "paymentCustomerId": "",
    "defaultPaymentMethodId": "",
    "invoiceAddress": {
        "id": "0c4b600e-007d-02ec-0300-592b7e972e00",
        "name": "John",
        "country": "AL",
        "state": "BDG",
        "city": "city",
        "areaCode": "110063",
        "mobileNumber": "1234567890",
        "phoneNumber": "1234567890",
        "email": "foo@example.com",
        "address": "New York street 2"
    },
    "shippingAddress": {
        "id": "1c4b605e-067d-02ec-0300-592b7e972e09",
        "name": "John",
        "country": "AL",
        "state": "BDG",
        "city": "city",
        "areaCode": "110063",
        "mobileNumber": "1234567890",
        "phoneNumber": "1234567890",
        "email": "foo@example.com",
        "address": "New York Street 2"
    },
    "website": "",
    "subscriptionId": "",
    "subscriptionUpdatedAt": null,
    "subscriptionCreatedAt": null,
    "status": "inactive",
    "limits": {
        "maxApplicationsPerOrg": 50,
        "maxFunctionsPerApp": 100,
        "maxBucketsPerOrg": 20,
        "maxFilesPerBucket": 10000,
        "maxDomainsPerOrg": 10,
        "maxRecordsPerDomain": 50,
        "maxRulesPerDomain": 50,
        "maxCertificatesPerDomain": 50,
        "maxNodesPerOrg": 1000,
        "maxCertificatesPerNode": 50,
        "maxUsersPerOrg": 50
    },
    "primaryOrg": false,
    "applications": {
        "size": 1,
        "href": "https://api.edjx.net/api/applications?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "nodes": {
        "size": 0,
        "href": "https://api.edjx.net/api/nodes?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "buckets": {
        "size": 0,
        "href": "https://api.edjx.net/api/buckets?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "domains": {
        "size": 0,
        "href": "https://api.edjx.net/api/domains?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "users": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users",
        "method": "GET"
    },
    "createdBy": {
        "id": "000g0000-0a0b-0a0d-bbbb-0000000h0001"
    },
    "createdAt": "2021-10-11T08:58:27.861Z",
    "updatedAt": "2022-11-07T09:05:04.319Z",
    "update": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "taxId",
                "label": "Tax Id",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "website",
                "label": "Website",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?organization=374c1c04-5748-40cb-989a-ca1a389de33f",
        "method": "GET"
    },
    "addresses": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/addresses",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "paymentMethods": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/paymentMethods",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "transactions": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/transactions",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "currentSubscription": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/currentSubscription",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "additionalUsage": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/additionalUsage",
        "method": "GET",
        "rel": [
            "collection"
        ]
    }
}

PUT Update Organization

Updates the details of an organization.

Body Params

Body Params Description Type Required Format
name Unique organization name string No Minimum 2 characters are required
taxId Organization Tax ID string No
AuthorizationBearer TOKEN
Content-Typeapplication/json
Acceptapplication/ion+json
Status200
Access-Control-Allow-Origin*
Content-Length3209
Content-Typeapplication/json; charset=utf-8
DateTue, 08 Nov 2022 05:13:25 GMT
EtagW/"c89-mjMtVpt/KNdttAk33i7AXz7aN7w"
ServerEDJX
Traceparent00-8a4189057c4d85ef994687c3c2185eca-ac0acb57be38f69a-01
X-Corelation-Id8a4189057c4d85ef994687c3c2185eca
X-Powered-ByExpress
Sample request
Update Organization
curl -X PUT -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -H "Accept: application/ion+json" -d '{
    "name":"MyFirstUpdatedOrg",
	"taxId":"{{TAX_ID}}"
}' "https://api.edjx.net/api/organizations/:organizationId"
PUT /api/organizations/:organizationId HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Content-Type: application/json
Accept: application/ion+json

{
    "name":"MyFirstUpdatedOrg",
	"taxId":"{{TAX_ID}}"
}
{
    "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
    "id": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "name": "MyFirstUpdatedOrg",
    "taxId": "",
    "currency": "usd",
    "paymentAccountId": "",
    "paymentCustomerId": "",
    "defaultPaymentMethodId": "",
    "invoiceAddress": {
        "id": "0c4b600e-007d-02ec-0300-592b7e972e00",
        "name": "John",
        "country": "AL",
        "state": "BDG",
        "city": "city",
        "areaCode": "110063",
        "mobileNumber": "1234567890",
        "phoneNumber": "1234567890",
        "email": "foo@example.com",
        "address": "New York street 2"
    },
    "shippingAddress": {
        "id": "1c4b605e-067d-02ec-0300-592b7e972e09",
        "name": "John",
        "country": "AL",
        "state": "BDG",
        "city": "city",
        "areaCode": "110063",
        "mobileNumber": "1234567890",
        "phoneNumber": "1234567890",
        "email": "foo@example.com",
        "address": "New York Street 2"
    },
    "website": "",
    "subscriptionId": "",
    "subscriptionUpdatedAt": null,
    "subscriptionCreatedAt": null,
    "status": "inactive",
    "limits": {
        "maxApplicationsPerOrg": 50,
        "maxFunctionsPerApp": 100,
        "maxBucketsPerOrg": 20,
        "maxFilesPerBucket": 10000,
        "maxDomainsPerOrg": 10,
        "maxRecordsPerDomain": 50,
        "maxRulesPerDomain": 50,
        "maxCertificatesPerDomain": 50,
        "maxNodesPerOrg": 1000,
        "maxCertificatesPerNode": 50,
        "maxUsersPerOrg": 50
    },
    "primaryOrg": false,
    "applications": {
        "size": 1,
        "href": "https://api.edjx.net/api/applications?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "nodes": {
        "size": 0,
        "href": "https://api.edjx.net/api/nodes?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "buckets": {
        "size": 0,
        "href": "https://api.edjx.net/api/buckets?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "domains": {
        "size": 0,
        "href": "https://api.edjx.net/api/domains?organization.id=374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "users": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users",
        "method": "GET"
    },
    "createdBy": {
        "id": "000g0000-0a0b-0a0d-bbbb-0000000h0001"
    },
    "createdAt": "2021-10-11T08:58:27.861Z",
    "updatedAt": "2022-11-07T09:05:04.319Z",
    "update": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "taxId",
                "label": "Tax Id",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "website",
                "label": "Website",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?organization=374c1c04-5748-40cb-989a-ca1a389de33f",
        "method": "GET"
    },
    "addresses": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/addresses",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "paymentMethods": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/paymentMethods",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "transactions": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/transactions",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "currentSubscription": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/currentSubscription",
        "method": "GET",
        "rel": [
            "collection"
        ]
    },
    "additionalUsage": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/additionalUsage",
        "method": "GET",
        "rel": [
            "collection"
        ]
    }
}

GET List Users

Lists users associated with an organization.

AuthorizationBearer TOKEN
Content-Typeapplication/json
Acceptapplication/ion+json
Status200
Access-Control-Allow-Origin*
Content-Length2995
Content-Typeapplication/json; charset=utf-8
DateTue, 08 Nov 2022 05:11:18 GMT
EtagW/"bb3-TycBThQUu+x/kq0W8xnT9MT0aF0"
ServerEDJX
Traceparent00-ad867f481cdc4901da451a872d4bb6b1-ec7d3e97fd45fa88-01
X-Corelation-Idad867f481cdc4901da451a872d4bb6b1
X-Powered-ByExpress
Sample request
List Users
curl -X GET -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -H "Accept: application/ion+json" "https://api.edjx.net/api/organizations/:organizationId/users"
GET /api/organizations/:organizationId/users HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Content-Type: application/json
Accept: application/ion+json
{
    "self": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 1,
    "first": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": null,
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users?page=1",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users/974c1c05-5748-40cb-989b-ca2a389de33h",
            "id": "974c1c05-5748-40cb-989b-ca2a389de33h",
            "name": "John",
            "email": "foo@example.com",
            "username": "John_roy",
            "phone": "",
            "status": "active",
            "timezone": 0,
            "timezoneLocation": "UTC",
            "photoUrl": "https://www.gravatar.com/avatar/7790ddb68f4320745f1bd1e7d60e2562?default=identicon",
            "createdAt": "2021-10-11T08:58:27.963Z",
            "updatedAt": "2021-10-11T08:58:27.963Z",
            "update": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users/974c1c05-5748-40cb-989b-ca2a389de33h",
                "method": "PUT",
                "rel": [
                    "edit-form"
                ],
                "value": [
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": false,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "username",
                        "label": "User Name",
                        "type": "string",
                        "enabled": false,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "email",
                        "label": "Email",
                        "type": "string",
                        "enabled": false,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "phone",
                        "label": "Phone",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "timezone",
                        "label": "Timezone",
                        "type": "string",
                        "enabled": false,
                        "visible": false
                    },
                    {
                        "name": "timezoneLocation",
                        "label": "Timezone",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "status",
                        "label": "Status",
                        "type": "string",
                        "enabled": false,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "groups",
                        "label": "Groups",
                        "type": "array",
                        "etype": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "pattern": {}
                    }
                ]
            },
            "remove": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users/974c1c05-5748-40cb-989b-ca2a389de33h",
                "method": "DELETE",
                "rel": [
                    "remove-form"
                ]
            },
            "activities": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users/974c1c05-5748-40cb-989b-ca2a389de33h/activities",
                "method": "GET",
                "rel": [
                    "collection"
                ]
            },
            "become": {
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f/users/974c1c05-5748-40cb-989b-ca2a389de33h",
                "method": "POST",
                "rel": [
                    "become-form"
                ]
            }
        }
    ],
    "invite": {
        "href": "https://api.edjx.net/api/invites",
        "rel": [
            "create-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "email",
                "label": "email",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "groups",
                "label": "Groups",
                "type": "array",
                "etype": "string",
                "minlength": 1,
                "enabled": true,
                "pattern": {},
                "required": true,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            }
        ]
    }
}

Applications


An application is a software entity that consists of one or more executable functions.

POST Create Application

Creates an application in an organization.

Body Params

Body Params Description Type Required Format
organization UUID string Yes
name Unique application name within an organization string Yes
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length2741
Content-Typeapplication/json; charset=utf-8
DateMon, 31 Oct 2022 06:17:29 GMT
EtagW/"ab5-RejDTbfmrRtqfcQlDL782DNf8xk"
ServerEDJX
Traceparent00-9f59632b8f3f286e9ac6c814a2e6dbef-4ffd00f53f03b573-01
X-Corelation-Id9f59632b8f3f286e9ac6c814a2e6dbef
X-Powered-ByExpress
Sample request
Create Application
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{ 
    "organization": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "name": "myFirstApplication"
}' "https://api.edjx.net/api/applications"
POST /api/applications HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{ 
    "organization": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "name": "myFirstApplication"
}
{
    "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "name": "myFirstApplication",
    "status": "active",
    "size": "0",
    "functions": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions",
        "rel": [
            "collection"
        ]
    },
    "stats": {
        "computeGB": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "network": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=network&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "requests": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=requests&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "storages": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=storages&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        }
    },
    "organization": {
        "href": "https://api.edjx.net/api/organizations/000o0000-0a0b-0a0d-oobb-0000000o0111",
        "id": "000o0000-0a0b-0a0d-oobb-0000000o0111"
    },
    "deployments": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments",
        "rel": [
            "collection"
        ]
    },
    "logs": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs",
        "rel": [
            "collection"
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=application&resourceId=000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "collection"
        ]
    },
    "requests": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests",
        "rel": [
            "collection"
        ]
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/000u0000-0u0b-0u0d-uobb-0000000u0000",
        "id": "000u0000-0u0b-0u0d-uobb-0000000u0000"
    },
    "createdAt": "2022-10-31T06:17:29.000Z",
    "updatedAt": "2022-10-31T06:17:29.856Z",
    "delete": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "visible": true
            },
            {
                "name": "status",
                "label": "Status",
                "type": "string",
                "enabled": true,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    }
}

GET Read All Applications

Gets the list of all applications from all organizations.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Status200
Access-Control-Allow-Origin*
Content-Length4421
Content-Typeapplication/json; charset=utf-8
DateMon, 31 Oct 2022 05:54:10 GMT
EtagW/"1145-Hc49w3sPsT8QmbVysq5xXYhrSsM"
ServerEDJX
Traceparent00-c8c8fbaaaf650294370aeffc9f1fc8d1-9ad7f92705a2b930-01
X-Corelation-Idc8c8fbaaaf650294370aeffc9f1fc8d1
X-Powered-ByExpress
Sample request
Read All Applications
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" "https://api.edjx.net/api/applications?limit=1"
GET /api/applications?limit=1 HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
{
    "self": {
        "href": "https://api.edjx.net/api/applications?limit=1",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 1,
    "first": {
        "href": "https://api.edjx.net/api/applications?limit=1&page=1",
        "rel": [
            "collection"
        ]
    },
    "next": {
        "href": "https://api.edjx.net/api/applications?limit=1&page=2",
        "rel": [
            "collection"
        ]
    },
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/applications?limit=1&page=2976",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "total": 1,
        "inactive": 0,
        "active": 1
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "name": "myFirstApplication",
            "status": "active",
            "size": "0",
            "functions": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions",
                "rel": [
                    "collection"
                ],
                "size": 0
            },
            "stats": {
                "computeGB": {
                    "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
                    "rel": [
                        "collection"
                    ],
                    "count": null
                },
                "network": {
                    "href": "https://api.edjx.net/api/stats?resource=application&type=network&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
                    "rel": [
                        "collection"
                    ],
                    "count": null
                },
                "requests": {
                    "href": "https://api.edjx.net/api/stats?resource=application&type=requests&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
                    "rel": [
                        "collection"
                    ],
                    "count": null
                },
                "storages": {
                    "href": "https://api.edjx.net/api/stats?resource=application&type=storages&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
                    "rel": [
                        "collection"
                    ],
                    "count": null
                }
            },
            "organization": {
                "id": "000o0000-0a0b-0a0d-oobb-0000000o0111",
                "name": "QADevEnvOrg01",
                "href": "https://api.edjx.net/api/organizations/000o0000-0a0b-0a0d-oobb-0000000o0111"
            },
            "deployments": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments",
                "rel": [
                    "collection"
                ]
            },
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs",
                "rel": [
                    "collection"
                ]
            },
            "activities": {
                "href": "https://api.edjx.net/api/activities?resource=application&resourceId=000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "rel": [
                    "collection"
                ]
            },
            "requests": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests",
                "rel": [
                    "collection"
                ]
            },
            "createdBy": {
                "id": "974c1c05-5748-40cb-989b-ca2a389de33h",
                "name": "John",
                "email": "foo@example.com",
                "photoUrl": "https://www.gravatar.com/avatar/fc8e269fe96b425c3663a6ec276011f0?default=identicon",
                "href": "https://api.edjx.net/api/users/000u0000-0u0b-0u0d-uobb-0000000u0000"
            },
            "createdAt": "2022-10-31T01:50:50.000Z",
            "updatedAt": "2022-10-31T01:50:50.246Z",
            "delete": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "id",
                        "label": "ID",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "pattern": {},
                        "enabled": true,
                        "visible": true
                    },
                    {
                        "name": "status",
                        "label": "Status",
                        "type": "string",
                        "enabled": true,
                        "visible": true
                    },
                    {
                        "name": "organization",
                        "label": "Organization",
                        "type": "string",
                        "enabled": false,
                        "required": true,
                        "visible": true
                    }
                ]
            }
        }
    ],
    "create": {
        "href": "https://api.edjx.net/api/applications",
        "rel": [
            "create-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "pattern": {},
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            }
        ]
    },
    "stats": {
        "computeGB": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB",
            "rel": [
                "collection"
            ]
        },
        "network": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=network",
            "rel": [
                "collection"
            ]
        },
        "requests": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=requests",
            "rel": [
                "collection"
            ]
        },
        "storages": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=storages",
            "rel": [
                "collection"
            ]
        }
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=application"
    }
}

GET Read Application

Gets the details for a specific application.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Status200
Access-Control-Allow-Origin*
Content-Length2916
Content-Typeapplication/json; charset=utf-8
DateMon, 31 Oct 2022 06:19:19 GMT
EtagW/"b64-A1cowXO1ig7El91pCo/I0ptwSaw"
ServerEDJX
Traceparent00-2591f5072ef961ef9315a7962cc5d8e9-ce8fc346a4e2bafb-01
X-Corelation-Id2591f5072ef961ef9315a7962cc5d8e9
X-Powered-ByExpress
Sample request
Read Application
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" "https://api.edjx.net/api/applications/:applicationId"
GET /api/applications/:applicationId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
{
    "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "name": "myFirstApplication",
    "status": "active",
    "size": "0",
    "functions": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions",
        "rel": [
            "collection"
        ],
        "size": 0
    },
    "stats": {
        "computeGB": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "network": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=network&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "requests": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=requests&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "storages": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=storages&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        }
    },
    "organization": {
        "id": "1bbe7096-717e-4199-a274-f17a0395f927",
        "name": "edjx",
        "href": "https://api.edjx.net/api/organizations/1bbe7096-717e-4199-a274-f17a0395f927"
    },
    "deployments": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments",
        "rel": [
            "collection"
        ]
    },
    "logs": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs",
        "rel": [
            "collection"
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=application&resourceId=000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "collection"
        ]
    },
    "requests": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests",
        "rel": [
            "collection"
        ]
    },
    "createdBy": {
        "id": "974c1c05-5748-40cb-989b-ca2a389de33h",
        "name": "John",
        "email": "foo@example.com",
        "photoUrl": "https://www.gravatar.com/avatar/50da1613642e7ac6463492478bb9e278?default=identicon",
        "href": "https://api.edjx.net/api/users/000u0000-0u0b-0u0d-uobb-0000000u0000"
    },
    "createdAt": "2022-10-31T06:17:29.000Z",
    "updatedAt": "2022-10-31T06:17:29.856Z",
    "delete": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "visible": true
            },
            {
                "name": "status",
                "label": "Status",
                "type": "string",
                "enabled": true,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    }
}

PUT Update Application

Updates the details of an application.

Body Params

Body Params Description Type Required Format
name New name of the application string No
status Status of the application. Sets the application to active (true) or inactive (false).
Default is active.
string No active or inactive
AuthorizationBearer TOKEN
Content-Typeapplication/json
Acceptapplication/ion+json
Status200
Access-Control-Allow-Origin*
Content-Length2743
Content-Typeapplication/json; charset=utf-8
DateFri, 04 Nov 2022 13:21:26 GMT
EtagW/"ab7-uek2yQQQQPbLnBIPnb4/ELJ5FvI"
ServerEDJX
Traceparent00-465c330d3904f5d0a2b996f2a31980fc-4917ba995d62facc-01
X-Corelation-Id465c330d3904f5d0a2b996f2a31980fc
X-Powered-ByExpress
Sample request
Update Application
curl -X PUT -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -H "Accept: application/ion+json" -d '{
    "name": "myFirstUpdatedApplication",
    "status": "active"
}' "https://api.edjx.net/api/applications/:applicationId"
PUT /api/applications/:applicationId HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Content-Type: application/json
Accept: application/ion+json

{
    "name": "myFirstUpdatedApplication",
    "status": "active"
}
{
    "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "name": "myFirstUpdatedApplication",
    "status": "inactive",
    "size": "0",
    "functions": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions",
        "rel": [
            "collection"
        ]
    },
    "stats": {
        "computeGB": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "network": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=network&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "requests": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=requests&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "storages": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=storages&application.id=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": null
        }
    },
    "organization": {
        "href": "https://api.edjx.net/api/organizations/000o0000-0a0b-0a0d-oobb-0000000o0111",
        "id": "374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "deployments": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments",
        "rel": [
            "collection"
        ]
    },
    "logs": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs",
        "rel": [
            "collection"
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=application&resourceId=000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "collection"
        ]
    },
    "requests": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests",
        "rel": [
            "collection"
        ]
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/000u0000-0u0b-0u0d-uobb-0000000u0000",
        "id": "000u0000-0u0b-0u0d-uobb-0000000u0000"
    },
    "createdAt": "2022-11-04T12:45:48.000Z",
    "updatedAt": "2022-11-04T13:21:26.367Z",
    "delete": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "visible": true
            },
            {
                "name": "status",
                "label": "Status",
                "type": "string",
                "enabled": true,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    }
}

DELETE Delete Application

Deletes an application.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length46
Content-Typeapplication/json; charset=utf-8
DateMon, 31 Oct 2022 06:14:21 GMT
EtagW/"2e-2QLqYmEIk1VqVYVbgEi6udou0So"
ServerEDJX
Traceparent00-6838d83d7e158f53b5bdc341ba144124-a9d759d71957cb02-01
X-Corelation-Id6838d83d7e158f53b5bdc341ba144124
X-Powered-ByExpress
Sample request
Delete Application
curl -X DELETE -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/applications/:applicationId"
DELETE /api/applications/:applicationId HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "message": "Application Deleted successfully"
}

Functions


Functions logically relate to the purpose of an application. An application consists of one or more executable functions.

POST Create Function

Creates a function within an application.

Body Params

Body Params Description Type Required Format
name Unique function name string Yes
language Code language of the function string Yes c++ or rust
memoryAllocated Memory allocated for the function integer Yes
runTime Runtime environment for the function string Yes wasm
timeout Timeout for the function integer Yes
policies Policies for the function Array of UUIDs No
trigger Trigger for the function string Yes http
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length4380
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 10:49:48 GMT
EtagW/"111c-Lfyy1TFwpLiSof6URCNORU+jm2o"
ServerEDJX
Traceparent00-246ff081019c9fbbe866873653acdb43-bf48cee33f72340f-01
X-Corelation-Id246ff081019c9fbbe866873653acdb43
X-Powered-ByExpress
Sample request
Create Function
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{ 
    "name" : "myFirstFunction",
    "properties": {
        "language": "rust",
        "memoryAllocated": 134217728,
        "runtime": "wasm",
        "timeout": 30000,
         "trigger": "http"
    },
    "policies" : []
}' "https://api.edjx.net/api/applications/:applicationId/deployments"
POST /api/applications/:applicationId/deployments HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{ 
    "name" : "myFirstFunction",
    "properties": {
        "language": "rust",
        "memoryAllocated": 134217728,
        "runtime": "wasm",
        "timeout": 30000,
         "trigger": "http"
    },
    "policies" : []
}
{
    "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments/000f0000-0f0b-0u0d-fobb-0000000f0000",
    "id": "000f0000-0f0b-0u0d-fobb-0000000f0000",
    "name": "myFirstFunction",
    "status": "deploying",
    "options": null,
    "error": "",
    "properties": {
        "language": "rust",
        "memoryAllocated": 134217728,
        "runtime": "wasm",
        "timeout": 30000,
        "trigger": "http"
    },
    "function": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions/000f0000-0f0b-0u0d-fobb-0000000f0000",
        "id": "000f0000-0f0b-0u0d-fobb-0000000f0000"
    },
    "application": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/000u0000-0u0b-0u0d-uobb-0000000u0000"
    },
    "createdAt": "2022-11-07T10:49:48.814Z",
    "updatedAt": "2022-11-07T10:49:48.814Z",
    "deploy": {
        "href": "https://000g0000-0a0b-0a0d-bbbb-0000000h0000--ttngj.storage.edjx.net/blobs/exampleFunction?edjx-meta-functionId=000f0000-0f0b-0u0d-fobb-0000000f0000&edjx-meta-language=rust&edjx-meta-memoryAllocated=134217728&edjx-meta-runtime=wasm&edjx-meta-timeout=30000&edjx-meta-trigger=http&policies=",
        "method": "PUT",
        "produces": "application/json+ion",
        "accepts": "multipart/form-data",
        "value": [
            {
                "name": "file",
                "label": "File",
                "type": "file",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "notarize",
                "label": "Notarize",
                "type": "boolean",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "peer-addrs",
                "label": "Peer Address",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "callBackURL",
                "label": "CallBack URL",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": false
            },
            {
                "name": "bucketID",
                "label": "bucket Id",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": false
            },
            {
                "name": "token",
                "label": "Token",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": false
            }
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments/000f0000-0f0b-0u0d-fobb-0000000f0000",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments/000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "cid",
                "label": "CID",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "rootBlockId",
                "label": "rootBlockId",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "size",
                "label": "Size",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "ingress",
                "label": "Ingress",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "status",
                "label": "status",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false,
                "options": [
                    {
                        "label": "success",
                        "value": "success"
                    },
                    {
                        "label": "failed",
                        "value": "failed"
                    }
                ]
            },
            {
                "name": "error",
                "label": "error",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "properties",
                "label": "Properties",
                "type": "object",
                "enabled": true,
                "required": false,
                "visible": false,
                "form": {
                    "value": [
                        {
                            "name": "trigger",
                            "label": "Trigger",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "HTTP",
                                    "value": "http"
                                }
                            ]
                        },
                        {
                            "name": "language",
                            "label": "Language",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "Rust",
                                    "value": "rust"
                                },
                                {
                                    "label": "C++",
                                    "value": "c++"
                                }
                            ]
                        },
                        {
                            "name": "runtime",
                            "label": "Runtime",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "WASM",
                                    "value": "wasm"
                                }
                            ]
                        },
                        {
                            "name": "memoryAllocated",
                            "label": "Memory Allocated",
                            "type": "string",
                            "options": [
                                {
                                    "label": "16 MiB",
                                    "value": 16777216
                                },
                                {
                                    "label": "32 MiB",
                                    "value": 33554432
                                },
                                {
                                    "label": "64 MiB",
                                    "value": 67108864
                                },
                                {
                                    "label": "128 MiB",
                                    "value": 134217728
                                },
                                {
                                    "label": "256 MiB",
                                    "value": 268435456
                                },
                                {
                                    "label": "512 MiB",
                                    "value": 536870912
                                }
                            ],
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "timeout",
                            "label": "Timeout",
                            "type": "string",
                            "options": [
                                {
                                    "label": "1 sec",
                                    "value": 1000
                                },
                                {
                                    "label": "5 sec",
                                    "value": 5000
                                },
                                {
                                    "label": "30 sec",
                                    "value": 30000
                                },
                                {
                                    "label": "1 min",
                                    "value": 60000
                                },
                                {
                                    "label": "5 min",
                                    "value": 300000
                                },
                                {
                                    "label": "30 min",
                                    "value": 1800000
                                },
                                {
                                    "label": "1 hour",
                                    "value": 3600000
                                }
                            ],
                            "enabled": true,
                            "required": true,
                            "visible": true
                        }
                    ]
                }
            }
        ]
    }
}

GET Read All Functions

Gets the list of all functions within an application.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length14320
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 10:48:14 GMT
EtagW/"37f0-T142i8EBHlMJ5cbh55+IMYqDysk"
ServerEDJX
Traceparent00-c3044bef5d8f94b484863fbfd80b4370-601eb900d93acd16-01
X-Corelation-Idc3044bef5d8f94b484863fbfd80b4370
X-Powered-ByExpress
Sample request
Read All Functions
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/applications/:applicationId/functions"
GET /api/applications/:applicationId/functions HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/functions",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 1,
    "first": {
        "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/functions?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": null,
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/functions?page=1",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "total": 1,
        "active": 1
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/functions/Fn2",
            "id": "000f0000-0f0b-0u0d-fobb-0000000f0000",
            "name": "myFirstFunction",
            "trigger": "http",
            "timeout": 30000,
            "memoryAllocated": 33554432,
            "language": "c++",
            "runtime": "wasm",
            "topic": null,
            "size": "69547",
            "status": "active",
            "application": {
                "id": "000f0000-0f0b-0u0d-fobb-0000000f0000",
                "name": "myFirstApplication",
                "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000"
            },
            "organization": {
                "id": "000o0000-0a0b-0a0d-oobb-0000000o0111",
                "name": "Documentation",
                "href": "https://api.edjx.net/api/organizations/000o0000-0a0b-0a0d-oobb-0000000o0111"
            },
            "createdAt": "2022-11-07T10:46:56.410Z",
            "updatedAt": "2022-11-07T10:46:57.573Z",
            "createdBy": {
                "id": "000u0000-0u0b-0u0d-uobb-0000000u0000",
                "name": "John",
                "email": "foo@example.com",
                "photoUrl": "https://www.gravatar.com/avatar/7790ddb68f4320745f1bd1e7d60e2562?default=identicon"
            },
            "stats": {
                "computeGB": {
                    "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
                    "rel": [
                        "collection"
                    ],
                    "count": null
                },
                "network": {
                    "href": "https://api.edjx.net/api/stats?resource=application&type=network&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
                    "rel": [
                        "collection"
                    ],
                    "count": null
                },
                "requests": {
                    "href": "https://api.edjx.net/api/stats?resource=application&type=requests&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
                    "rel": [
                        "collection"
                    ],
                    "count": null
                }
            },
            "logs": {
                "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/logs?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
                "rel": [
                    "collection"
                ]
            },
            "requests": {
                "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/requests?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
                "rel": [
                    "collection"
                ]
            },
            "deploy": {
                "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/deployments",
                "rel": [
                    "form"
                ],
                "method": "POST",
                "produces": "application/json+ion",
                "value": [
                    {
                        "name": "name",
                        "label": "Key",
                        "type": "string",
                        "pattern": {},
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "options",
                        "label": "Options",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": false
                    },
                    {
                        "name": "properties",
                        "label": "Properties",
                        "type": "object",
                        "enabled": true,
                        "required": false,
                        "visible": false,
                        "form": {
                            "value": [
                                {
                                    "name": "trigger",
                                    "label": "Trigger",
                                    "type": "string",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true,
                                    "options": [
                                        {
                                            "label": "HTTP",
                                            "value": "http"
                                        }
                                    ]
                                },
                                {
                                    "name": "language",
                                    "label": "Language",
                                    "type": "string",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true,
                                    "options": [
                                        {
                                            "label": "Rust",
                                            "value": "rust"
                                        },
                                        {
                                            "label": "C++",
                                            "value": "c++"
                                        }
                                    ]
                                },
                                {
                                    "name": "runtime",
                                    "label": "Runtime",
                                    "type": "string",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true,
                                    "options": [
                                        {
                                            "label": "WASM",
                                            "value": "wasm"
                                        }
                                    ]
                                },
                                {
                                    "name": "memoryAllocated",
                                    "label": "Memory Allocated",
                                    "type": "string",
                                    "options": [
                                        {
                                            "label": "16 MiB",
                                            "value": 16777216
                                        },
                                        {
                                            "label": "32 MiB",
                                            "value": 33554432
                                        },
                                        {
                                            "label": "64 MiB",
                                            "value": 67108864
                                        },
                                        {
                                            "label": "128 MiB",
                                            "value": 134217728
                                        },
                                        {
                                            "label": "256 MiB",
                                            "value": 268435456
                                        },
                                        {
                                            "label": "512 MiB",
                                            "value": 536870912
                                        }
                                    ],
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                },
                                {
                                    "name": "timeout",
                                    "label": "Timeout",
                                    "type": "string",
                                    "options": [
                                        {
                                            "label": "1 sec",
                                            "value": 1000
                                        },
                                        {
                                            "label": "5 sec",
                                            "value": 5000
                                        },
                                        {
                                            "label": "30 sec",
                                            "value": 30000
                                        },
                                        {
                                            "label": "1 min",
                                            "value": 60000
                                        },
                                        {
                                            "label": "5 min",
                                            "value": 300000
                                        },
                                        {
                                            "label": "30 min",
                                            "value": 1800000
                                        },
                                        {
                                            "label": "1 hour",
                                            "value": 3600000
                                        }
                                    ],
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                }
                            ]
                        }
                    },
                    {
                        "name": "policies",
                        "label": "Policies",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "etype": "string",
                        "visible": false,
                        "pattern": {}
                    },
                    {
                        "name": "functionId",
                        "label": "Function ID",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "deployments": {
                "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/deployments?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
                "rel": [
                    "collection"
                ]
            },
            "activities": {
                "href": "https://api.edjx.net/api/activities?resource=application&resourceId=000f0000-0f0b-0u0d-fobb-0000000f0000",
                "rel": [
                    "collection"
                ]
            },
            "delete": {
                "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/functions/Fn2",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/functions/Fn2",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "id",
                        "label": "ID",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "trigger",
                        "label": "Trigger",
                        "type": "string",
                        "enabled": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "HTTP",
                                "value": "http"
                            }
                        ]
                    },
                    {
                        "name": "language",
                        "label": "Language",
                        "type": "string",
                        "enabled": false,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "Rust",
                                "value": "rust"
                            },
                            {
                                "label": "C++",
                                "value": "c++"
                            }
                        ]
                    },
                    {
                        "name": "runtime",
                        "label": "Runtime",
                        "type": "string",
                        "enabled": false,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "WASM",
                                "value": "wasm"
                            }
                        ]
                    },
                    {
                        "name": "memoryAllocated",
                        "type": "number",
                        "label": "Memory Allocated",
                        "options": [
                            {
                                "label": "16 MiB",
                                "value": 16777216
                            },
                            {
                                "label": "32 MiB",
                                "value": 33554432
                            },
                            {
                                "label": "64 MiB",
                                "value": 67108864
                            },
                            {
                                "label": "128 MiB",
                                "value": 134217728
                            },
                            {
                                "label": "256 MiB",
                                "value": 268435456
                            },
                            {
                                "label": "512 MiB",
                                "value": 536870912
                            }
                        ],
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "timeout",
                        "type": "number",
                        "label": "Timeout",
                        "options": [
                            {
                                "label": "1 sec",
                                "value": 1000
                            },
                            {
                                "label": "5 sec",
                                "value": 5000
                            },
                            {
                                "label": "30 sec",
                                "value": 30000
                            },
                            {
                                "label": "1 min",
                                "value": 60000
                            },
                            {
                                "label": "5 min",
                                "value": 300000
                            },
                            {
                                "label": "30 min",
                                "value": 1800000
                            },
                            {
                                "label": "1 hour",
                                "value": 3600000
                            }
                        ],
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "policies",
                        "label": "Policies",
                        "type": "array",
                        "etype": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true,
                        "pattern": {}
                    }
                ]
            },
            "execute": {
                "href": "https://000f0000-0f0b-0u0d-fobb-0000000f0000.fn.edjx.net/Fn2",
                "method": "ANY"
            }
        }
    ],
    "deploy": {
        "href": "https://api.edjx.net/api/applications/000f0000-0f0b-0u0d-fobb-0000000f0000/deployments",
        "rel": [
            "form"
        ],
        "method": "POST",
        "produces": "application/json+ion",
        "value": [
            {
                "name": "name",
                "label": "Key",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "options",
                "label": "Options",
                "type": "array",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "properties",
                "label": "Properties",
                "type": "object",
                "enabled": true,
                "required": false,
                "visible": false,
                "form": {
                    "value": [
                        {
                            "name": "trigger",
                            "label": "Trigger",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "HTTP",
                                    "value": "http"
                                }
                            ]
                        },
                        {
                            "name": "language",
                            "label": "Language",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "Rust",
                                    "value": "rust"
                                },
                                {
                                    "label": "C++",
                                    "value": "c++"
                                }
                            ]
                        },
                        {
                            "name": "runtime",
                            "label": "Runtime",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "WASM",
                                    "value": "wasm"
                                }
                            ]
                        },
                        {
                            "name": "memoryAllocated",
                            "label": "Memory Allocated",
                            "type": "string",
                            "options": [
                                {
                                    "label": "16 MiB",
                                    "value": 16777216
                                },
                                {
                                    "label": "32 MiB",
                                    "value": 33554432
                                },
                                {
                                    "label": "64 MiB",
                                    "value": 67108864
                                },
                                {
                                    "label": "128 MiB",
                                    "value": 134217728
                                },
                                {
                                    "label": "256 MiB",
                                    "value": 268435456
                                },
                                {
                                    "label": "512 MiB",
                                    "value": 536870912
                                }
                            ],
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "timeout",
                            "label": "Timeout",
                            "type": "string",
                            "options": [
                                {
                                    "label": "1 sec",
                                    "value": 1000
                                },
                                {
                                    "label": "5 sec",
                                    "value": 5000
                                },
                                {
                                    "label": "30 sec",
                                    "value": 30000
                                },
                                {
                                    "label": "1 min",
                                    "value": 60000
                                },
                                {
                                    "label": "5 min",
                                    "value": 300000
                                },
                                {
                                    "label": "30 min",
                                    "value": 1800000
                                },
                                {
                                    "label": "1 hour",
                                    "value": 3600000
                                }
                            ],
                            "enabled": true,
                            "required": true,
                            "visible": true
                        }
                    ]
                }
            },
            {
                "name": "policies",
                "label": "Policies",
                "type": "array",
                "enabled": true,
                "required": false,
                "etype": "string",
                "visible": false,
                "pattern": {}
            },
            {
                "name": "functionId",
                "label": "Function ID",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            }
        ]
    }
}

GET Read Function

Gets the details of a specific function within an application.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length5959
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 10:49:20 GMT
EtagW/"1747-puqNcxkf97qhoghpsSEDoT4Zuik"
ServerEDJX
Traceparent00-8a03d1c30881552492cb995060014544-093d4ff4afdd6b09-01
X-Corelation-Id8a03d1c30881552492cb995060014544
X-Powered-ByExpress
Sample request
Read Function
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/applications/:applicationId/functions/:functionName"
GET /api/applications/:applicationId/functions/:functionName HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions/myFirstFunction",
    "id": "000f0000-0f0b-0u0d-fobb-0000000f0000",
    "name": "myFirstFunction",
    "trigger": "https",
    "timeout": 1000,
    "memoryAllocated": 16777216,
    "language": "rust",
    "runtime": "wasm",
    "topic": null,
    "size": "1680151",
    "status": "active",
    "application": {
        "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "name": "myFirstApplication",
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "organization": {
        "id": "374c1c04-5748-40cb-989a-ca1a389de33f",
        "name": "MyFirstOrg",
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "createdAt": "2022-11-07T10:46:35.987Z",
    "updatedAt": "2022-11-07T10:46:38.518Z",
    "createdBy": {
        "id": "3ad71999-2069-406d-a51a-f7796f762c7a",
        "name": "John",
        "email": "foo@example.com",
        "photoUrl": "https://www.gravatar.com/avatar/7790ddb68f4320745f1bd1e7d60e2562?default=identicon"
    },
    "stats": {
        "computeGB": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "network": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=network&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "requests": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=requests&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
            "rel": [
                "collection"
            ],
            "count": null
        }
    },
    "logs": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "collection"
        ]
    },
    "requests": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "collection"
        ]
    },
    "policies": [],
    "deploy": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments",
        "rel": [
            "form"
        ],
        "method": "POST",
        "produces": "application/json+ion",
        "value": [
            {
                "name": "name",
                "label": "Key",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "options",
                "label": "Options",
                "type": "array",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "properties",
                "label": "Properties",
                "type": "object",
                "enabled": true,
                "required": false,
                "visible": false,
                "form": {
                    "value": [
                        {
                            "name": "trigger",
                            "label": "Trigger",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "HTTP",
                                    "value": "http"
                                }
                            ]
                        },
                        {
                            "name": "language",
                            "label": "Language",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "Rust",
                                    "value": "rust"
                                },
                                {
                                    "label": "C++",
                                    "value": "c++"
                                }
                            ]
                        },
                        {
                            "name": "runtime",
                            "label": "Runtime",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "WASM",
                                    "value": "wasm"
                                }
                            ]
                        },
                        {
                            "name": "memoryAllocated",
                            "label": "Memory Allocated",
                            "type": "string",
                            "options": [
                                {
                                    "label": "16 MiB",
                                    "value": 16777216
                                },
                                {
                                    "label": "32 MiB",
                                    "value": 33554432
                                },
                                {
                                    "label": "64 MiB",
                                    "value": 67108864
                                },
                                {
                                    "label": "128 MiB",
                                    "value": 134217728
                                },
                                {
                                    "label": "256 MiB",
                                    "value": 268435456
                                },
                                {
                                    "label": "512 MiB",
                                    "value": 536870912
                                }
                            ],
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "timeout",
                            "label": "Timeout",
                            "type": "string",
                            "options": [
                                {
                                    "label": "1 sec",
                                    "value": 1000
                                },
                                {
                                    "label": "5 sec",
                                    "value": 5000
                                },
                                {
                                    "label": "30 sec",
                                    "value": 30000
                                },
                                {
                                    "label": "1 min",
                                    "value": 60000
                                },
                                {
                                    "label": "5 min",
                                    "value": 300000
                                },
                                {
                                    "label": "30 min",
                                    "value": 1800000
                                },
                                {
                                    "label": "1 hour",
                                    "value": 3600000
                                }
                            ],
                            "enabled": true,
                            "required": true,
                            "visible": true
                        }
                    ]
                }
            },
            {
                "name": "policies",
                "label": "Policies",
                "type": "array",
                "enabled": true,
                "required": false,
                "etype": "string",
                "visible": false,
                "pattern": {}
            },
            {
                "name": "functionId",
                "label": "Function ID",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            }
        ]
    },
    "deployments": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "collection"
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=application&resourceId=000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "collection"
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions/myFirstFunction",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions/myFirstFunction",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "trigger",
                "label": "Trigger",
                "type": "string",
                "enabled": false,
                "visible": true,
                "options": [
                    {
                        "label": "HTTP",
                        "value": "http"
                    }
                ]
            },
            {
                "name": "language",
                "label": "Language",
                "type": "string",
                "enabled": false,
                "required": false,
                "visible": true,
                "options": [
                    {
                        "label": "Rust",
                        "value": "rust"
                    },
                    {
                        "label": "C++",
                        "value": "c++"
                    }
                ]
            },
            {
                "name": "runtime",
                "label": "Runtime",
                "type": "string",
                "enabled": false,
                "required": false,
                "visible": true,
                "options": [
                    {
                        "label": "WASM",
                        "value": "wasm"
                    }
                ]
            },
            {
                "name": "memoryAllocated",
                "type": "number",
                "label": "Memory Allocated",
                "options": [
                    {
                        "label": "16 MiB",
                        "value": 16777216
                    },
                    {
                        "label": "32 MiB",
                        "value": 33554432
                    },
                    {
                        "label": "64 MiB",
                        "value": 67108864
                    },
                    {
                        "label": "128 MiB",
                        "value": 134217728
                    },
                    {
                        "label": "256 MiB",
                        "value": 268435456
                    },
                    {
                        "label": "512 MiB",
                        "value": 536870912
                    }
                ],
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "timeout",
                "type": "number",
                "label": "Timeout",
                "options": [
                    {
                        "label": "1 sec",
                        "value": 1000
                    },
                    {
                        "label": "5 sec",
                        "value": 5000
                    },
                    {
                        "label": "30 sec",
                        "value": 30000
                    },
                    {
                        "label": "1 min",
                        "value": 60000
                    },
                    {
                        "label": "5 min",
                        "value": 300000
                    },
                    {
                        "label": "30 min",
                        "value": 1800000
                    },
                    {
                        "label": "1 hour",
                        "value": 3600000
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "policies",
                "label": "Policies",
                "type": "array",
                "etype": "string",
                "enabled": true,
                "required": true,
                "visible": true,
                "pattern": {}
            }
        ]
    },
    "execute": {
        "href": "https://000g0000-0a0b-0a0d-bbbb-0000000h0000.fn.edjx.net/myFirstFunction",
        "method": "ANY"
    }
}

PUT Update Function

Updates a specific function within an application.

Body Params

Body Params Description Type Required Format
language Code language of the function string No c++ or rust
memoryAllocated Memory allocated for the function integer No
runTime Runtime environment for the function string No wasm
timeout Timeout for the function integer Yes
policies Policies for the function Array of UUIDs Yes
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length5681
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 10:50:32 GMT
EtagW/"1631-2yAC3CIrNtcLiziBNnyk/iT21OM"
ServerEDJX
Traceparent00-b043a04616723f45fee3cb7b623d4395-8020e18a8fafc755-01
X-Corelation-Idb043a04616723f45fee3cb7b623d4395
X-Powered-ByExpress
Sample request
Update Function
curl -X PUT -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
  "runtime": "wasm",
  "language": "rust",
  "timeout": 5000,
  "memoryAllocated": 16777216,
  "policies": [
    "9ac47b1c-2064-429f-8ea1-522823b4f6a2"
  ]
}' "https://api.edjx.net/api/applications/:applicationId/functions/:functionName"
PUT /api/applications/:applicationId/functions/:functionName HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
  "runtime": "wasm",
  "language": "rust",
  "timeout": 5000,
  "memoryAllocated": 16777216,
  "policies": [
    "9ac47b1c-2064-429f-8ea1-522823b4f6a2"
  ]
}
{
    "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions/myFirstFunction",
    "id": "000f0000-0f0b-0u0d-fobb-0000000f0000",
    "name": "myFirstFunction",
    "trigger": "http",
    "timeout": 5000,
    "memoryAllocated": 16777216,
    "language": "rust",
    "runtime": "wasm",
    "topic": null,
    "size": "0",
    "status": "active",
    "application": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "organization": {
        "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268",
        "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268"
    },
    "createdAt": "2022-11-07T10:49:48.807Z",
    "updatedAt": "2022-11-07T10:50:32.499Z",
    "createdBy": "3ad71999-2069-406d-a51a-f7796f762c7a",
    "stats": {
        "computeGB": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "network": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=network&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
            "rel": [
                "collection"
            ],
            "count": null
        },
        "requests": {
            "href": "https://api.edjx.net/api/stats?resource=application&type=requests&function.id=000f0000-0f0b-0u0d-fobb-0000000f0000",
            "rel": [
                "collection"
            ],
            "count": null
        }
    },
    "logs": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "collection"
        ]
    },
    "requests": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "collection"
        ]
    },
    "deploy": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments",
        "rel": [
            "form"
        ],
        "method": "POST",
        "produces": "application/json+ion",
        "value": [
            {
                "name": "name",
                "label": "Key",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "options",
                "label": "Options",
                "type": "array",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "properties",
                "label": "Properties",
                "type": "object",
                "enabled": true,
                "required": false,
                "visible": false,
                "form": {
                    "value": [
                        {
                            "name": "trigger",
                            "label": "Trigger",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "HTTP",
                                    "value": "http"
                                }
                            ]
                        },
                        {
                            "name": "language",
                            "label": "Language",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "Rust",
                                    "value": "rust"
                                },
                                {
                                    "label": "C++",
                                    "value": "c++"
                                }
                            ]
                        },
                        {
                            "name": "runtime",
                            "label": "Runtime",
                            "type": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true,
                            "options": [
                                {
                                    "label": "WASM",
                                    "value": "wasm"
                                }
                            ]
                        },
                        {
                            "name": "memoryAllocated",
                            "label": "Memory Allocated",
                            "type": "string",
                            "options": [
                                {
                                    "label": "16 MiB",
                                    "value": 16777216
                                },
                                {
                                    "label": "32 MiB",
                                    "value": 33554432
                                },
                                {
                                    "label": "64 MiB",
                                    "value": 67108864
                                },
                                {
                                    "label": "128 MiB",
                                    "value": 134217728
                                },
                                {
                                    "label": "256 MiB",
                                    "value": 268435456
                                },
                                {
                                    "label": "512 MiB",
                                    "value": 536870912
                                }
                            ],
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "timeout",
                            "label": "Timeout",
                            "type": "string",
                            "options": [
                                {
                                    "label": "1 sec",
                                    "value": 1000
                                },
                                {
                                    "label": "5 sec",
                                    "value": 5000
                                },
                                {
                                    "label": "30 sec",
                                    "value": 30000
                                },
                                {
                                    "label": "1 min",
                                    "value": 60000
                                },
                                {
                                    "label": "5 min",
                                    "value": 300000
                                },
                                {
                                    "label": "30 min",
                                    "value": 1800000
                                },
                                {
                                    "label": "1 hour",
                                    "value": 3600000
                                }
                            ],
                            "enabled": true,
                            "required": true,
                            "visible": true
                        }
                    ]
                }
            },
            {
                "name": "policies",
                "label": "Policies",
                "type": "array",
                "enabled": true,
                "required": false,
                "etype": "string",
                "visible": false,
                "pattern": {}
            },
            {
                "name": "functionId",
                "label": "Function ID",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            }
        ]
    },
    "deployments": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/deployments?functionId=000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "collection"
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=application&resourceId=000f0000-0f0b-0u0d-fobb-0000000f0000",
        "rel": [
            "collection"
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions/myFirstFunction",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/functions/myFirstFunction",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "trigger",
                "label": "Trigger",
                "type": "string",
                "enabled": false,
                "visible": true,
                "options": [
                    {
                        "label": "HTTP",
                        "value": "http"
                    }
                ]
            },
            {
                "name": "language",
                "label": "Language",
                "type": "string",
                "enabled": false,
                "required": false,
                "visible": true,
                "options": [
                    {
                        "label": "Rust",
                        "value": "rust"
                    },
                    {
                        "label": "C++",
                        "value": "c++"
                    }
                ]
            },
            {
                "name": "runtime",
                "label": "Runtime",
                "type": "string",
                "enabled": false,
                "required": false,
                "visible": true,
                "options": [
                    {
                        "label": "WASM",
                        "value": "wasm"
                    }
                ]
            },
            {
                "name": "memoryAllocated",
                "type": "number",
                "label": "Memory Allocated",
                "options": [
                    {
                        "label": "16 MiB",
                        "value": 16777216
                    },
                    {
                        "label": "32 MiB",
                        "value": 33554432
                    },
                    {
                        "label": "64 MiB",
                        "value": 67108864
                    },
                    {
                        "label": "128 MiB",
                        "value": 134217728
                    },
                    {
                        "label": "256 MiB",
                        "value": 268435456
                    },
                    {
                        "label": "512 MiB",
                        "value": 536870912
                    }
                ],
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "timeout",
                "type": "number",
                "label": "Timeout",
                "options": [
                    {
                        "label": "1 sec",
                        "value": 1000
                    },
                    {
                        "label": "5 sec",
                        "value": 5000
                    },
                    {
                        "label": "30 sec",
                        "value": 30000
                    },
                    {
                        "label": "1 min",
                        "value": 60000
                    },
                    {
                        "label": "5 min",
                        "value": 300000
                    },
                    {
                        "label": "30 min",
                        "value": 1800000
                    },
                    {
                        "label": "1 hour",
                        "value": 3600000
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "policies",
                "label": "Policies",
                "type": "array",
                "etype": "string",
                "enabled": true,
                "required": true,
                "visible": true,
                "pattern": {}
            }
        ]
    }
}

DELETE Delete Function

Deletes a function within an application.

AuthorizationBearer TOKEN
Content-Typeapplication/json
Acceptapplication/ion+json
Status200
Access-Control-Allow-Origin*
Content-Length43
Content-Typeapplication/json; charset=utf-8
DateMon, 07 Nov 2022 10:51:30 GMT
EtagW/"2b-qBJh5xPe4h1xIMo4cMTwN4X+SaQ"
ServerEDJX
Traceparent00-8d02ac3966f4df9f63f5f12c7501a1e7-f5ad4f5eed222758-01
X-Corelation-Id8d02ac3966f4df9f63f5f12c7501a1e7
X-Powered-ByExpress
Sample request
Delete Function
curl -X DELETE -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -H "Accept: application/ion+json" "https://api.edjx.net/api/applications/:applicationId/functions/:functionName"
DELETE /api/applications/:applicationId/functions/:functionName HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Content-Type: application/json
Accept: application/ion+json
{
    "message": "Function Deleted successfully"
}

Activities


View all activities performed by the user on the EDJX Platform.

GET Get All Activities

Gets all activities performed across all applications and associated functions in an organization.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length8225
Content-Typeapplication/json
DateMon, 07 Nov 2022 11:22:21 GMT
EtagW/"2021-FU+ErHXYjv/0gTnCsc0QlPbFQLg"
ServerEDJX
Traceparent00-6f7ff37875582432f8e7885d52e9e9e5-6de9df60621d8d2e-01
X-Corelation-Id6f7ff37875582432f8e7885d52e9e9e5
X-Powered-ByExpress
Sample request
Get All Activities
curl -X GET -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/activities"
GET /api/activities HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/activities",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 1632,
    "first": {
        "href": "https://api.edjx.net/api/activities?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": {
        "href": "https://api.edjx.net/api/activities?page=2",
        "rel": [
            "collection"
        ]
    },
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/activities?page=164",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "id": "ec6ae8aa-ea21-40a9-b98a-4bbc7e786b44",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "failed",
            "action": "deploy",
            "text": "Deployment Failed",
            "resourceName": "exampleFunction",
            "resourceType": "function",
            "resourceId": "4d4a2922-0b5b-4f1a-b710-41390c98ba76",
            "actorType": "user",
            "actorName": "Automation Test",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "4d4a2922-0b5b-4f1a-b710-41390c98ba76"
            ],
            "context": {
                "language": "rust",
                "memoryAllocated": 134217728,
                "policies": "[]",
                "runtime": "wasm",
                "timeout": 30000,
                "trigger": "http"
            },
            "timestamp": "2022-11-07T11:15:02.760Z"
        },
        {
            "id": "5d226075-f239-4971-9f6d-07ae0ec8f36b",
            "organization": {
                "id": "d455f391-17c0-4057-9661-51294010f41c",
                "href": "https://api.edjx.net/api/organizations/d455f391-17c0-4057-9661-51294010f41c"
            },
            "status": "failed",
            "action": "deploy",
            "text": "Deployment Failed",
            "resourceName": "func_afN9u",
            "resourceType": "function",
            "resourceId": "e72428f8-47d0-40de-878a-a29ce21011b7",
            "actorType": "user",
            "actorName": "Automation Test",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "fa6f212a-97a4-49c7-b2b8-89c90d53e135",
                "function",
                "e72428f8-47d0-40de-878a-a29ce21011b7"
            ],
            "context": {
                "language": "rust",
                "memoryAllocated": 134217728,
                "policies": "[]",
                "runtime": "wasm",
                "timeout": 30000,
                "trigger": "http"
            },
            "timestamp": "2022-11-07T11:00:05.430Z"
        },
        {
            "id": "a56a5de1-af9d-441e-be13-52da34c8ef7d",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "success",
            "action": "create",
            "text": "Created",
            "resourceName": "exampleFunction",
            "resourceType": "function",
            "resourceId": "4d4a2922-0b5b-4f1a-b710-41390c98ba76",
            "actorType": "user",
            "actorName": "",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "4d4a2922-0b5b-4f1a-b710-41390c98ba76"
            ],
            "context": {
                "trigger": "http",
                "name": "exampleFunction",
                "timeout": 30000,
                "memoryAllocated": 134217728,
                "runtime": "wasm",
                "language": "rust",
                "policies": []
            },
            "timestamp": "2022-11-07T10:51:52.780Z"
        },
        {
            "id": "d72f64e5-d390-4848-a931-d84b68539a90",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "success",
            "action": "delete",
            "text": "Deleted",
            "resourceName": "exampleFunction",
            "resourceType": "function",
            "resourceId": "eae0d05a-0903-47cc-b6d2-23f6623c5031",
            "actorType": "user",
            "actorName": "",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "eae0d05a-0903-47cc-b6d2-23f6623c5031"
            ],
            "context": {},
            "timestamp": "2022-11-07T10:51:30.918Z"
        },
        {
            "id": "0d89f6a4-9669-4ec3-886e-9e60b776c098",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "success",
            "action": "update",
            "text": "Updated",
            "resourceName": "exampleFunction",
            "resourceType": "function",
            "resourceId": "eae0d05a-0903-47cc-b6d2-23f6623c5031",
            "actorType": "user",
            "actorName": "",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "eae0d05a-0903-47cc-b6d2-23f6623c5031"
            ],
            "context": {
                "timeout": 5000,
                "memoryAllocated": 16777216,
                "policies": [
                    "9ac47b1c-2064-429f-8ea1-522823b4f6a2"
                ]
            },
            "timestamp": "2022-11-07T10:50:32.528Z"
        },
        {
            "id": "8756a653-ecb3-44f6-b6d3-b3c57964f72b",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "success",
            "action": "create",
            "text": "Created",
            "resourceName": "exampleFunction",
            "resourceType": "function",
            "resourceId": "eae0d05a-0903-47cc-b6d2-23f6623c5031",
            "actorType": "user",
            "actorName": "",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "eae0d05a-0903-47cc-b6d2-23f6623c5031"
            ],
            "context": {
                "trigger": "http",
                "name": "exampleFunction",
                "timeout": 30000,
                "memoryAllocated": 134217728,
                "runtime": "wasm",
                "language": "rust",
                "policies": []
            },
            "timestamp": "2022-11-07T10:49:48.812Z"
        },
        {
            "id": "d0de4c76-d5ca-497a-a7b7-a5364acf15d9",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "success",
            "action": "deploy",
            "text": "Deployed",
            "resourceName": "Fn2",
            "resourceType": "function",
            "resourceId": "f86729e6-3702-4cfc-8671-69aabdb3bd91",
            "actorType": "user",
            "actorName": "Automation Test",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "f86729e6-3702-4cfc-8671-69aabdb3bd91"
            ],
            "context": {
                "timeout": 30000,
                "trigger": "http",
                "memoryAllocated": 33554432,
                "runtime": "wasm",
                "language": "c++",
                "policies": []
            },
            "timestamp": "2022-11-07T10:46:57.581Z"
        },
        {
            "id": "1dc854ae-61a1-4849-a348-841ee405239f",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "success",
            "action": "create",
            "text": "Created",
            "resourceName": "Fn2",
            "resourceType": "function",
            "resourceId": "f86729e6-3702-4cfc-8671-69aabdb3bd91",
            "actorType": "user",
            "actorName": "",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "f86729e6-3702-4cfc-8671-69aabdb3bd91"
            ],
            "context": {
                "trigger": "http",
                "name": "Fn2",
                "timeout": 30000,
                "memoryAllocated": 33554432,
                "runtime": "wasm",
                "language": "c++",
                "policies": []
            },
            "timestamp": "2022-11-07T10:46:56.413Z"
        },
        {
            "id": "9d02aa84-2289-4607-b6bc-827ccea98cc9",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "success",
            "action": "deploy",
            "text": "Deployed",
            "resourceName": "Fn1",
            "resourceType": "function",
            "resourceId": "10bccce7-76e3-4ed3-80bd-1b31ca5fba4f",
            "actorType": "user",
            "actorName": "Automation Test",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "10bccce7-76e3-4ed3-80bd-1b31ca5fba4f"
            ],
            "context": {
                "timeout": 1000,
                "trigger": "http",
                "memoryAllocated": 16777216,
                "runtime": "wasm",
                "language": "rust",
                "policies": []
            },
            "timestamp": "2022-11-07T10:46:38.586Z"
        },
        {
            "id": "7b0fc5d7-e124-4999-acaf-d15103a79809",
            "organization": {
                "id": "c5ef1668-7723-4eb6-a5ae-bc95caa76268",
                "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
            },
            "status": "success",
            "action": "create",
            "text": "Created",
            "resourceName": "Fn1",
            "resourceType": "function",
            "resourceId": "10bccce7-76e3-4ed3-80bd-1b31ca5fba4f",
            "actorType": "user",
            "actorName": "",
            "actorId": "3ad71999-2069-406d-a51a-f7796f762c7a",
            "becomer": {
                "name": "",
                "id": null
            },
            "userName": "Automation Test",
            "tags": [
                "application",
                "ceaf8716-5dea-4162-8cfc-54c7b108ce5d",
                "function",
                "10bccce7-76e3-4ed3-80bd-1b31ca5fba4f"
            ],
            "context": {
                "trigger": "http",
                "name": "Fn1",
                "timeout": 1000,
                "memoryAllocated": 16777216,
                "runtime": "wasm",
                "language": "rust",
                "policies": []
            },
            "timestamp": "2022-11-07T10:46:35.993Z"
        }
    ]
}

Users


Provides access to the user account and gets details of all users associated with the account.

GET Get All Groups

Lists all users associated with a group.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length63192
Content-Typeapplication/json
DateTue, 08 Nov 2022 10:31:13 GMT
EtagW/"f6d8-j66pD+Lr6sUTGKEoapyqZelTJEM"
ServerEDJX
Traceparent00-e909b5c4a2c734fd1b3c28b30dcae8fa-1b0805af615674e7-01
X-Corelation-Ide909b5c4a2c734fd1b3c28b30dcae8fa
X-Powered-ByExpress
Sample request
Get All Groups
curl -X GET -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/users/:userId/groups"
GET /api/users/:userId/groups HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h/groups",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 35,
    "first": {
        "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h/groups?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": {
        "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h/groups?page=2",
        "rel": [
            "collection"
        ]
    },
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h/groups?page=4",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/groups/aaa00000-b0cc-00a0-b111-0a0000ba11b1",
            "id": "aaa00000-b0cc-00a0-b111-0a0000ba11b1",
            "name": "Anonymous User",
            "isMember": true,
            "description": "This group define access to anonymous users",
            "organization": {
                "id": "374c1c04-5748-40cb-989a-ca1a389de33f",
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
            },
            "members": {
                "href": "https://api.edjx.net/api/groups/aaa00000-b0cc-00a0-b111-0a0000ba11b1/members"
            },
            "isAnonymous": true,
            "createdBy": {
                "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h",
                "id": "974c1c05-5748-40cb-989b-ca2a389de33h"
            },
            "createdAt": "2022-10-03T11:42:59.000Z",
            "updatedAt": "2022-10-03T11:42:59.996Z",
            "delete": {
                "href": "https://api.edjx.net/api/groups/aaa00000-b0cc-00a0-b111-0a0000ba11b1",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/groups/aaa00000-b0cc-00a0-b111-0a0000ba11b1",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "organization",
                        "label": "Organization",
                        "type": "string",
                        "enabled": false,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "updateMembers": {
                "href": "https://api.edjx.net/api/groups/aaa00000-b0cc-00a0-b111-0a0000ba11b1/members",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "include",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "exclude",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "policies": {
                "href": "https://api.edjx.net/api/groups/aaa00000-b0cc-00a0-b111-0a0000ba11b1/policies"
            }
        },
        {
            "href": "https://api.edjx.net/api/groups/aaa11111-b1cc-11a1-b111-1a1111ba11b1",
            "id": "aaa11111-b1cc-11a1-b111-1a1111ba11b1",
            "name": "Administrators",
            "isMember": true,
            "description": "The members of this group have full access to all of organization's resources and users.",
            "organization": {
                "id": "578fd52f-add2-4ea9-9858-db3ea91e9ae4",
                "href": "https://api.edjx.net/api/organizations/578fd52f-add2-4ea9-9858-db3ea91e9ae4"
            },
            "members": {
                "href": "https://api.edjx.net/api/groups/aaa11111-b1cc-11a1-b111-1a1111ba11b1/members"
            },
            "isAnonymous": false,
            "createdBy": {
                "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h",
                "id": "974c1c05-5748-40cb-989b-ca2a389de33h"
            },
            "createdAt": "2021-10-20T12:12:32.000Z",
            "updatedAt": "2021-10-20T12:12:32.043Z",
            "delete": {
                "href": "https://api.edjx.net/api/groups/aaa11111-b1cc-11a1-b111-1a1111ba11b1",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/groups/aaa11111-b1cc-11a1-b111-1a1111ba11b1",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "organization",
                        "label": "Organization",
                        "type": "string",
                        "enabled": false,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "updateMembers": {
                "href": "https://api.edjx.net/api/groups/aaa11111-b1cc-11a1-b111-1a1111ba11b1/members",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "include",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "exclude",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "policies": {
                "href": "https://api.edjx.net/api/groups/aaa11111-b1cc-11a1-b111-1a1111ba11b1/policies"
            }
        },
        {
            "href": "https://api.edjx.net/api/groups/aaa22222-b2cc-22a2-b222-2a2222ba22b2",
            "id": "aaa22222-b2cc-22a2-b222-2a2222ba22b2",
            "name": "Developers",
            "isMember": true,
            "description": "Create, execute and manage applications and functions.",
            "organization": {
                "id": "6d4a32b0-ad00-4be0-a5d2-094237172813",
                "href": "https://api.edjx.net/api/organizations/6d4a32b0-ad00-4be0-a5d2-094237172813"
            },
            "members": {
                "href": "https://api.edjx.net/api/groups/aaa22222-b2cc-22a2-b222-2a2222ba22b2/members"
            },
            "isAnonymous": false,
            "createdBy": {
                "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h",
                "id": "974c1c05-5748-40cb-989b-ca2a389de33h"
            },
            "createdAt": "2021-10-14T11:01:50.000Z",
            "updatedAt": "2021-10-14T11:01:50.932Z",
            "delete": {
                "href": "https://api.edjx.net/api/groups/aaa22222-b2cc-22a2-b222-2a2222ba22b2",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/groups/aaa22222-b2cc-22a2-b222-2a2222ba22b2",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "organization",
                        "label": "Organization",
                        "type": "string",
                        "enabled": false,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "updateMembers": {
                "href": "https://api.edjx.net/api/groups/aaa22222-b2cc-22a2-b222-2a2222ba22b2/members",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "include",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "exclude",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "policies": {
                "href": "https://api.edjx.net/api/groups/aaa22222-b2cc-22a2-b222-2a2222ba22b2/policies"
            }
        },
        {
            "href": "https://api.edjx.net/api/groups/aaa33333-b3cc-33a3-b333-3a3333ba33b3",
            "id": "aaa33333-b3cc-33a3-b333-3a3333ba33b3",
            "name": "Node Operators",
            "isMember": true,
            "description": "Create and manage nodes.",
            "organization": {
                "id": "6d4a32b0-ad00-4be0-a5d2-094237172813",
                "href": "https://api.edjx.net/api/organizations/6d4a32b0-ad00-4be0-a5d2-094237172813"
            },
            "members": {
                "href": "https://api.edjx.net/api/groups/aaa33333-b3cc-33a3-b333-3a3333ba33b3/members"
            },
            "isAnonymous": false,
            "createdBy": {
                "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h",
                "id": "974c1c05-5748-40cb-989b-ca2a389de33h"
            },
            "createdAt": "2021-10-14T11:01:50.000Z",
            "updatedAt": "2021-10-14T11:01:50.920Z",
            "delete": {
                "href": "https://api.edjx.net/api/groups/aaa33333-b3cc-33a3-b333-3a3333ba33b3",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/groups/aaa33333-b3cc-33a3-b333-3a3333ba33b3",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "organization",
                        "label": "Organization",
                        "type": "string",
                        "enabled": false,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "updateMembers": {
                "href": "https://api.edjx.net/api/groups/aaa33333-b3cc-33a3-b333-3a3333ba33b3/members",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "include",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "exclude",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    }
                ]
            },
            "policies": {
                "href": "https://api.edjx.net/api/groups/aaa33333-b3cc-33a3-b333-3a3333ba33b3/policies"
            }
        }
    ],
    "create": {
        "href": "https://api.edjx.net/api/groups",
        "rel": [
            "create-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "description",
                "label": "Description",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "enabled": true,
                "pattern": {},
                "required": true,
                "visible": true
            }
        ]
    }
}

Policies


EDJX provides the following system policies, which allow assignment or removal of access levels for function execution:

  • Files Full access policy, Files Read only policy: Provides read-write access to the EDJX object storage.
  • KV Full access policy, KV Read only policy: Provides read-write access to the EDJX Key-Value store.

GET Read Function Policies

Gets the details of all function policies.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Status200
Access-Control-Allow-Origin*
Content-Length10811
Content-Typeapplication/json
DateTue, 08 Nov 2022 17:25:03 GMT
EtagW/"2a3b-z7HqVX1j73qQz74VW0l/gmGRL3k"
ServerEDJX
Traceparent00-bba7c733eb4ae08d2a6856a0076ad053-5b4f977c1585246c-01
X-Corelation-Idbba7c733eb4ae08d2a6856a0076ad053
X-Powered-ByExpress
Sample request
Read Function Policies
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H ": " "https://api.edjx.net/api/policies?principal=function"
GET /api/policies?principal=function HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
: 
{
    "self": {
        "href": "https://api.edjx.net/api/policies?principal=function",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 4,
    "first": {
        "href": "https://api.edjx.net/api/policies?principal=function&page=1",
        "rel": [
            "collection"
        ]
    },
    "next": null,
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/policies?principal=function&page=1",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/policies/aaa00000-b0cc-00a0-b111-0a0000ba11b1",
            "id": "aaa00000-b0cc-00a0-b111-0a0000ba11b1",
            "name": "KV Full access",
            "description": "This policy provides full access to Key Value Store of associated organization",
            "isUserDefined": false,
            "organization": null,
            "effect": "Allow",
            "resources": [
                "KV:*"
            ],
            "actions": [
                "*"
            ],
            "conditions": [],
            "principal": "function",
            "createdBy": {
                "href": "https://api.edjx.net/api/users/null"
            },
            "updatedBy": {
                "href": "https://api.edjx.net/api/users/null"
            },
            "createdAt": "2021-07-08T01:29:57.838Z",
            "updatedAt": "2021-07-08T01:29:57.838Z",
            "delete": {
                "href": "https://api.edjx.net/api/policies/aaa00000-b0cc-00a0-b111-0a0000ba11b1",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/policies/aaa00000-b0cc-00a0-b111-0a0000ba11b1",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "effect",
                        "label": "Effect",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "Allow",
                                "value": "Allow"
                            },
                            {
                                "label": "Deny",
                                "value": "Deny"
                            }
                        ]
                    },
                    {
                        "name": "isUserDefined",
                        "label": "Is User Defined",
                        "type": "boolean",
                        "enabled": true,
                        "required": false,
                        "visible": false
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "resources",
                        "label": "Resources",
                        "type": "array",
                        "etype": "string",
                        "minlength": 1,
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "actions",
                        "label": "Actions",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "etype": "string",
                        "minlength": 1,
                        "options": [
                            {
                                "label": "All",
                                "value": "*"
                            },
                            {
                                "label": "Read",
                                "value": "read"
                            },
                            {
                                "label": "List",
                                "value": "list"
                            },
                            {
                                "label": "Create",
                                "value": "create"
                            },
                            {
                                "label": "Update",
                                "value": "update"
                            },
                            {
                                "label": "Delete",
                                "value": "delete"
                            },
                            {
                                "label": "Execute",
                                "value": "execute"
                            }
                        ]
                    },
                    {
                        "name": "conditions",
                        "label": "Conditions",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "principal",
                        "label": "Principal",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "User",
                                "value": "user"
                            },
                            {
                                "label": "Function",
                                "value": "function"
                            },
                            {
                                "label": "Node",
                                "value": "node"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "href": "https://api.edjx.net/api/policies/aaa11111-b1cc-11a1-b111-1a1111ba11b1",
            "id": "aaa11111-b1cc-11a1-b111-1a1111ba11b1",
            "name": "KV Read only",
            "description": "This policy provides read only access to Key Value Store of associated organization",
            "isUserDefined": false,
            "organization": null,
            "effect": "Allow",
            "resources": [
                "KV:*"
            ],
            "actions": [
                "read"
            ],
            "conditions": [],
            "principal": "function",
            "createdBy": {
                "href": "https://api.edjx.net/api/users/null"
            },
            "updatedBy": {
                "href": "https://api.edjx.net/api/users/null"
            },
            "createdAt": "2021-07-08T01:29:57.838Z",
            "updatedAt": "2021-07-08T01:29:57.838Z",
            "delete": {
                "href": "https://api.edjx.net/api/policies/aaa11111-b1cc-11a1-b111-1a1111ba11b1",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/policies/aaa11111-b1cc-11a1-b111-1a1111ba11b1",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "effect",
                        "label": "Effect",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "Allow",
                                "value": "Allow"
                            },
                            {
                                "label": "Deny",
                                "value": "Deny"
                            }
                        ]
                    },
                    {
                        "name": "isUserDefined",
                        "label": "Is User Defined",
                        "type": "boolean",
                        "enabled": true,
                        "required": false,
                        "visible": false
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "resources",
                        "label": "Resources",
                        "type": "array",
                        "etype": "string",
                        "minlength": 1,
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "actions",
                        "label": "Actions",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "etype": "string",
                        "minlength": 1,
                        "options": [
                            {
                                "label": "All",
                                "value": "*"
                            },
                            {
                                "label": "Read",
                                "value": "read"
                            },
                            {
                                "label": "List",
                                "value": "list"
                            },
                            {
                                "label": "Create",
                                "value": "create"
                            },
                            {
                                "label": "Update",
                                "value": "update"
                            },
                            {
                                "label": "Delete",
                                "value": "delete"
                            },
                            {
                                "label": "Execute",
                                "value": "execute"
                            }
                        ]
                    },
                    {
                        "name": "conditions",
                        "label": "Conditions",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "principal",
                        "label": "Principal",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "User",
                                "value": "user"
                            },
                            {
                                "label": "Function",
                                "value": "function"
                            },
                            {
                                "label": "Node",
                                "value": "node"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "href": "https://api.edjx.net/api/policies/aaa22222-b2cc-22a2-b222-2a2222ba22b2",
            "id": "aaa22222-b2cc-22a2-b222-2a2222ba22b2",
            "name": "Files Full access",
            "description": "This policy provides full access to Files of all Buckets of associated organization",
            "isUserDefined": false,
            "organization": null,
            "effect": "Allow",
            "resources": [
                "buckets:*::files:*"
            ],
            "actions": [
                "*"
            ],
            "conditions": [],
            "principal": "function",
            "createdBy": {
                "href": "https://api.edjx.net/api/users/null"
            },
            "updatedBy": {
                "href": "https://api.edjx.net/api/users/null"
            },
            "createdAt": "2021-07-08T01:29:57.837Z",
            "updatedAt": "2021-07-08T01:29:57.837Z",
            "delete": {
                "href": "https://api.edjx.net/api/policies/aaa22222-b2cc-22a2-b222-2a2222ba22b2",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/policies/aaa22222-b2cc-22a2-b222-2a2222ba22b2",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "effect",
                        "label": "Effect",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "Allow",
                                "value": "Allow"
                            },
                            {
                                "label": "Deny",
                                "value": "Deny"
                            }
                        ]
                    },
                    {
                        "name": "isUserDefined",
                        "label": "Is User Defined",
                        "type": "boolean",
                        "enabled": true,
                        "required": false,
                        "visible": false
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "resources",
                        "label": "Resources",
                        "type": "array",
                        "etype": "string",
                        "minlength": 1,
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "actions",
                        "label": "Actions",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "etype": "string",
                        "minlength": 1,
                        "options": [
                            {
                                "label": "All",
                                "value": "*"
                            },
                            {
                                "label": "Read",
                                "value": "read"
                            },
                            {
                                "label": "List",
                                "value": "list"
                            },
                            {
                                "label": "Create",
                                "value": "create"
                            },
                            {
                                "label": "Update",
                                "value": "update"
                            },
                            {
                                "label": "Delete",
                                "value": "delete"
                            },
                            {
                                "label": "Execute",
                                "value": "execute"
                            }
                        ]
                    },
                    {
                        "name": "conditions",
                        "label": "Conditions",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "principal",
                        "label": "Principal",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "User",
                                "value": "user"
                            },
                            {
                                "label": "Function",
                                "value": "function"
                            },
                            {
                                "label": "Node",
                                "value": "node"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "href": "https://api.edjx.net/api/policies/aaa33333-b3cc-33a3-b333-3a3333ba33b3",
            "id": "aaa33333-b3cc-33a3-b333-3a3333ba33b3",
            "name": "Files Read only",
            "description": "This policy provides read only access to Files of all Buckets of associated organization",
            "isUserDefined": false,
            "organization": null,
            "effect": "Allow",
            "resources": [
                "buckets:*::files:*"
            ],
            "actions": [
                "read",
                "list"
            ],
            "conditions": [],
            "principal": "function",
            "createdBy": {
                "href": "https://api.edjx.net/api/users/null"
            },
            "updatedBy": {
                "href": "https://api.edjx.net/api/users/null"
            },
            "createdAt": "2021-07-08T01:29:57.837Z",
            "updatedAt": "2021-07-08T01:29:57.837Z",
            "delete": {
                "href": "https://api.edjx.net/api/policies/aaa33333-b3cc-33a3-b333-3a3333ba33b3",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/policies/aaa33333-b3cc-33a3-b333-3a3333ba33b3",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "effect",
                        "label": "Effect",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "Allow",
                                "value": "Allow"
                            },
                            {
                                "label": "Deny",
                                "value": "Deny"
                            }
                        ]
                    },
                    {
                        "name": "isUserDefined",
                        "label": "Is User Defined",
                        "type": "boolean",
                        "enabled": true,
                        "required": false,
                        "visible": false
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "resources",
                        "label": "Resources",
                        "type": "array",
                        "etype": "string",
                        "minlength": 1,
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "actions",
                        "label": "Actions",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "etype": "string",
                        "minlength": 1,
                        "options": [
                            {
                                "label": "All",
                                "value": "*"
                            },
                            {
                                "label": "Read",
                                "value": "read"
                            },
                            {
                                "label": "List",
                                "value": "list"
                            },
                            {
                                "label": "Create",
                                "value": "create"
                            },
                            {
                                "label": "Update",
                                "value": "update"
                            },
                            {
                                "label": "Delete",
                                "value": "delete"
                            },
                            {
                                "label": "Execute",
                                "value": "execute"
                            }
                        ]
                    },
                    {
                        "name": "conditions",
                        "label": "Conditions",
                        "type": "array",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "principal",
                        "label": "Principal",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true,
                        "options": [
                            {
                                "label": "User",
                                "value": "user"
                            },
                            {
                                "label": "Function",
                                "value": "function"
                            },
                            {
                                "label": "Node",
                                "value": "node"
                            }
                        ]
                    }
                ]
            }
        }
    ],
    "create": {
        "href": "https://api.edjx.net/api/policies",
        "rel": [
            "create-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "description",
                "label": "Description",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "effect",
                "label": "Effect",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true,
                "options": [
                    {
                        "label": "Allow",
                        "value": "Allow"
                    },
                    {
                        "label": "Deny",
                        "value": "Deny"
                    }
                ]
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "isUserDefined",
                "label": "Is User Defined",
                "type": "boolean",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "resources",
                "label": "Resources",
                "type": "array",
                "etype": "string",
                "minlength": 1,
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "actions",
                "label": "Actions",
                "type": "array",
                "enabled": true,
                "required": true,
                "visible": true,
                "etype": "string",
                "minlength": 1,
                "options": [
                    {
                        "label": "All",
                        "value": "*"
                    },
                    {
                        "label": "Read",
                        "value": "read"
                    },
                    {
                        "label": "List",
                        "value": "list"
                    },
                    {
                        "label": "Create",
                        "value": "create"
                    },
                    {
                        "label": "Update",
                        "value": "update"
                    },
                    {
                        "label": "Delete",
                        "value": "delete"
                    },
                    {
                        "label": "Execute",
                        "value": "execute"
                    }
                ]
            },
            {
                "name": "conditions",
                "label": "Conditions",
                "type": "array",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "principal",
                "label": "Principal",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true,
                "options": [
                    {
                        "label": "User",
                        "value": "user"
                    },
                    {
                        "label": "Function",
                        "value": "function"
                    },
                    {
                        "label": "Node",
                        "value": "node"
                    }
                ]
            }
        ]
    }
}

Buckets


Buckets store files. Each organization is allowed up to 20 buckets, where each bucket can store up to 10,000 files. A File refers to a file of any format such as .jpeg, .png, .pdf, .doc, and so on being uploaded to a specific bucket in an organization.

POST Create Bucket

Creates a bucket in an organization.

Body Params

Body Params Description Type Required Format
organization Organization UUID to associate with the bucket string Yes
name Unique bucket name string Ye Minimum 2 characters are required and a maximum of 128 characters are allowed, which includes only alphanumeric, hyphen, or underscore
isPublic Indicates if the contents of the bucket is public (true) or private (false).
Default: false
boolean No true or false
versioning Indicates if the contents of the bucket is versioned (true) or non-versioned (false).
Default: false
boolean No true or false
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length2061
Content-Typeapplication/json
DateTue, 08 Nov 2022 19:03:52 GMT
EtagW/"80d-gRjELCX72P9q3fnLe9VUVjK9/BA"
ServerEDJX
Traceparent00-d2fd6c57b9da4734198ee6e18ad29a6d-c05678b0053ad337-01
X-Corelation-Idd2fd6c57b9da4734198ee6e18ad29a6d
X-Powered-ByExpress
Sample request
Create Bucket
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{ 
    "organization": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "name": "myFirstBucket",
    "description": "From postman",
    "isPublic" : true,
    "Versioning": false
}' "https://api.edjx.net/api/buckets"
POST /api/buckets HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{ 
    "organization": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "name": "myFirstBucket",
    "description": "From postman",
    "isPublic" : true,
    "Versioning": false
}
{
    "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
    "id": "786d2d05-6668-40cb-989a-cb2b560af22a",
    "name": "myFirstBucket",
    "description": null,
    "isPublic": true,
    "versioning": false,
    "files": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a/files",
        "rel": [
            "collection"
        ]
    },
    "uploads": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a/uploads",
        "rel": [
            "collection"
        ]
    },
    "stats": {
        "downloads": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads&bucket.id=786d2d05-6668-40cb-989a-cb2b560af22a",
            "rel": [
                "collection"
            ],
            "count": "0"
        },
        "storages": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=storages&bucket.id=786d2d05-6668-40cb-989a-cb2b560af22a",
            "rel": [
                "collection"
            ],
            "count": "0"
        }
    },
    "size": "0",
    "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
        "id": "374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=bucket&resourceId=786d2d05-6668-40cb-989a-cb2b560af22a",
        "rel": [
            "collection"
        ]
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h"
    },
    "createdAt": "2022-11-08T19:03:52.000Z",
    "updatedAt": "2022-11-08T19:03:52.437Z",
    "delete": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "isPublic",
                "label": "Make Public",
                "type": "boolean",
                "enabled": true,
                "visible": true
            },
            {
                "name": "versioning",
                "label": "Track Versions",
                "type": "boolean",
                "enabled": false,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "pattern": {},
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    }
}

GET Read All Buckets

Lists all buckets associated with an organization.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length23671
Content-Typeapplication/json
DateTue, 08 Nov 2022 19:01:32 GMT
EtagW/"5c77-R7k1zxRKOhfavKOGIywYirbXIog"
ServerEDJX
Traceparent00-f753999ca95eb87e8369e31e82357cd6-86803a3a0431e2e2-01
X-Corelation-Idf753999ca95eb87e8369e31e82357cd6
X-Powered-ByExpress
Sample request
Read All Buckets
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/buckets"
GET /api/buckets HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/buckets",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 2,
    "first": {
        "href": "https://api.edjx.net/api/buckets?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": {
        "href": "https://api.edjx.net/api/buckets?page=2",
        "rel": [
            "collection"
        ]
    },
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/buckets?page=2689",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "total": 1,
        "private": 1,
        "public": 0
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
            "id": "786d2d05-6668-40cb-989a-cb2b560af22a",
            "name": "myFirstBucket",
            "description": null,
            "isPublic": true,
            "versioning": false,
            "files": {
                "size": 1348,
                "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a/files",
                "rel": [
                    "collection"
                ]
            },
            "uploads": {
                "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a/uploads",
                "rel": [
                    "collection"
                ]
            },
            "stats": {
                "downloads": {
                    "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads&bucket.id=786d2d05-6668-40cb-989a-cb2b560af22a",
                    "rel": [
                        "collection"
                    ],
                    "count": "0"
                },
                "storages": {
                    "href": "https://api.edjx.net/api/stats?resource=bucket&type=storages&bucket.id=786d2d05-6668-40cb-989a-cb2b560af22a",
                    "rel": [
                        "collection"
                    ],
                    "count": "0"
                }
            },
            "size": "690176000",
            "organization": {
                "name": "MyFirstOrg",
                "id": "374c1c04-5748-40cb-989a-ca1a389de33f",
                "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
            },
            "activities": {
                "href": "https://api.edjx.net/api/activities?resource=bucket&resourceId=786d2d05-6668-40cb-989a-cb2b560af22a",
                "rel": [
                    "collection"
                ]
            },
            "createdBy": {
                "id": "974c1c05-5748-40cb-989b-ca2a389de33h",
                "name": "John",
                "email": "foo@example.com",
                "photoUrl": null,
                "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h"
            },
            "createdAt": "2022-11-08T16:53:17.000Z",
            "updatedAt": "2022-11-08T16:56:19.925Z",
            "delete": {
                "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
                "method": "DELETE"
            },
            "update": {
                "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "id",
                        "label": "ID",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "pattern": {},
                        "label": "Name",
                        "type": "string",
                        "enabled": true,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "isPublic",
                        "label": "Make Public",
                        "type": "boolean",
                        "enabled": true,
                        "visible": true
                    },
                    {
                        "name": "versioning",
                        "label": "Track Versions",
                        "type": "boolean",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "organization",
                        "label": "Organization",
                        "pattern": {},
                        "type": "string",
                        "enabled": false,
                        "required": true,
                        "visible": true
                    }
                ]
            }
        }
    ],
    "create": {
        "href": "https://api.edjx.net/api/buckets",
        "rel": [
            "create-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "isPublic",
                "label": "Make Public",
                "type": "boolean",
                "enabled": true,
                "visible": true
            },
            {
                "name": "versioning",
                "label": "Track Versions",
                "type": "boolean",
                "enabled": true,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "pattern": {},
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            }
        ]
    },
    "stats": {
        "downloads": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads",
            "rel": [
                "collection"
            ]
        },
        "storages": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=storages",
            "rel": [
                "collection"
            ]
        }
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=bucket",
        "rel": [
            "collection"
        ]
    }
}

GET Read Bucket

Gets the details of a bucket.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length2232
Content-Typeapplication/json
DateTue, 08 Nov 2022 19:02:51 GMT
EtagW/"8b8-tR99XMjz/dAJ7M1jPtB8lJOghMk"
ServerEDJX
Traceparent00-76a84285c37e5940ed7089d26ac8b8dc-ee1b6365f8ab9673-01
X-Corelation-Id76a84285c37e5940ed7089d26ac8b8dc
X-Powered-ByExpress
Sample request
Read Bucket
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/buckets/:bucketId"
GET /api/buckets/:bucketId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
    "id": "786d2d05-6668-40cb-989a-cb2b560af22a",
    "name": "myFirstBucket",
    "description": null,
    "isPublic": true,
    "versioning": false,
    "files": {
        "size": 1348,
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a/files",
        "rel": [
            "collection"
        ]
    },
    "uploads": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a/uploads",
        "rel": [
            "collection"
        ]
    },
    "stats": {
        "downloads": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads&bucket.id=786d2d05-6668-40cb-989a-cb2b560af22a",
            "rel": [
                "collection"
            ],
            "count": "0"
        },
        "storages": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=storages&bucket.id=786d2d05-6668-40cb-989a-cb2b560af22a",
            "rel": [
                "collection"
            ],
            "count": "0"
        }
    },
    "size": "690176000",
    "organization": {
        "name": "MyFirstOrg",
        "id": "374c1c04-5748-40cb-989a-ca1a389de33f",
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=bucket&resourceId=786d2d05-6668-40cb-989a-cb2b560af22a",
        "rel": [
            "collection"
        ]
    },
    "createdBy": {
        "id": "974c1c05-5748-40cb-989b-ca2a389de33h",
        "name": "John",
        "email": "foo@example.com",
        "photoUrl": null,
        "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h"
    },
    "createdAt": "2022-11-08T16:53:17.000Z",
    "updatedAt": "2022-11-08T16:56:19.925Z",
    "delete": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "isPublic",
                "label": "Make Public",
                "type": "boolean",
                "enabled": true,
                "visible": true
            },
            {
                "name": "versioning",
                "label": "Track Versions",
                "type": "boolean",
                "enabled": false,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "pattern": {},
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    }
}

PUT Update Bucket

Updates the details of a bucket.

Body Params

Body Params Description Type Required Format
name Name of the bucket to update string No Minimum 2 characters are required and a maximum of 128 characters are allowed, which includes only alphanumeric, hyphen, or underscore
isPublic Indicates if the contents of the bucket is public (true) or private (false).
Default: false
boolean No true or false
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length2063
Content-Typeapplication/json
DateTue, 08 Nov 2022 19:04:53 GMT
EtagW/"80f-Yrq1DVJdrR3XB/Ryp1j3vIatHl4"
ServerEDJX
Traceparent00-5eb1efe970fabbd81d2a5823009eeddc-a787d0167332aaa0-01
X-Corelation-Id5eb1efe970fabbd81d2a5823009eeddc
X-Powered-ByExpress
Sample request
Update Bucket
curl -X PUT -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
    "name": "myFirstUpdatedBucket",
    "isPublic":"true"
}' "https://api.edjx.net/api/buckets/:bucketId"
PUT /api/buckets/:bucketId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
    "name": "myFirstUpdatedBucket",
    "isPublic":"true"
}
{
    "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
    "id": "786d2d05-6668-40cb-989a-cb2b560af22a",
    "name": "Bucket11",
    "description": null,
    "isPublic": false,
    "versioning": false,
    "files": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a/files",
        "rel": [
            "collection"
        ]
    },
    "uploads": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a/uploads",
        "rel": [
            "collection"
        ]
    },
    "stats": {
        "downloads": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads&bucket.id=786d2d05-6668-40cb-989a-cb2b560af22a",
            "rel": [
                "collection"
            ],
            "count": "0"
        },
        "storages": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=storages&bucket.id=786d2d05-6668-40cb-989a-cb2b560af22a",
            "rel": [
                "collection"
            ],
            "count": "0"
        }
    },
    "size": "0",
    "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f",
        "id": "374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=bucket&resourceId=786d2d05-6668-40cb-989a-cb2b560af22a",
        "rel": [
            "collection"
        ]
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/974c1c05-5748-40cb-989b-ca2a389de33h"
    },
    "createdAt": "2022-11-08T19:04:14.000Z",
    "updatedAt": "2022-11-08T19:04:53.757Z",
    "delete": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/buckets/786d2d05-6668-40cb-989a-cb2b560af22a",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "isPublic",
                "label": "Make Public",
                "type": "boolean",
                "enabled": true,
                "visible": true
            },
            {
                "name": "versioning",
                "label": "Track Versions",
                "type": "boolean",
                "enabled": false,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "pattern": {},
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    }
}

DELETE Delete Bucket

Deletes a bucket within an organization.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length41
Content-Typeapplication/json
DateTue, 08 Nov 2022 19:06:20 GMT
EtagW/"29-x3Q7tvrbhjmOaBlD3B+Vi2J6VWk"
ServerEDJX
Traceparent00-32507f4244dffe651599085624f7f30c-b32f7248de2ad1e3-01
X-Corelation-Id32507f4244dffe651599085624f7f30c
X-Powered-ByExpress
Sample request
Delete Bucket
curl -X DELETE -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/buckets/:bucketId"
DELETE /api/buckets/:bucketId HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "message": "Bucket Deleted successfully"
}

Files


Files APIs allow Web applications to access files and their contents.

POST Upload Files

Uploads files to a bucket.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length2757
Content-Typeapplication/json; charset=utf-8
DateFri, 11 Nov 2022 11:05:01 GMT
EtagW/"ac5-yFG1fpbb2VUAjJJ0wmZ6AzZbRVY"
ServerEDJX
Traceparent00-a71bd3223ad225b2967119b7d943da35-3a9a10e9ff9378e4-01
X-Corelation-Ida71bd3223ad225b2967119b7d943da35
X-Powered-ByExpress
Sample request
Upload Files
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{ 
    "name": "yourFileName.extension",
    "options":[],
    "properties": []
}' "https://api.edjx.net/api/buckets/:bucketId/uploads"
POST /api/buckets/:bucketId/uploads HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{ 
    "name": "yourFileName.extension",
    "options":[],
    "properties": []
}
{
    "href": "https://https://api.edjx.net/api/buckets/36ca629d-2168-4b4c-b130-97948e8f1bcf/uploads/d5de45aa-442d-4854-a117-049ecae5a036",
    "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "name": "yourFileName.extension",
    "status": "uploading",
    "options": [
        {
            "key": "notary",
            "value": false
        }
    ],
    "error": "",
    "properties": [],
    "file": null,
    "bucket": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0001"
    },
    "organization": {
        "href": "https://api.edjx.net/api/organizations/100g0000-0a0b-0a0d-bbbb-0000000h0001"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/200g0000-0a0b-0a0d-bbbb-0000000h0001"
    },
    "createdAt": "2022-11-11T11:05:01.333Z",
    "updatedAt": "2022-11-11T11:05:01.333Z",
    "upload": {
        "href": "https://36ca629d-2168-4b4c-b130-97948e8f1bcf--ttngj.storage.edjx.net/blobs/abc.png",
        "method": "PUT",
        "produces": "application/json+ion",
        "accepts": "multipart/form-data",
        "value": [
            {
                "name": "file",
                "label": "File",
                "type": "file",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "notarize",
                "label": "Notarize",
                "type": "boolean",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "peer-addrs",
                "label": "Peer Address",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": true
            },
            {
                "name": "callBackURL",
                "label": "CallBack URL",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": false
            },
            {
                "name": "bucketID",
                "label": "bucket Id",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": false
            },
            {
                "name": "token",
                "label": "Token",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": false
            }
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0001/uploads/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0001/uploads/000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "properties",
                "label": "Properties",
                "type": "array",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "cid",
                "label": "CID",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "rootBlockId",
                "label": "rootBlockId",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "size",
                "label": "Size",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "status",
                "label": "status",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false,
                "options": [
                    {
                        "label": "uploading",
                        "value": "uploading"
                    },
                    {
                        "label": "success",
                        "value": "success"
                    },
                    {
                        "label": "failed",
                        "value": "failed"
                    }
                ]
            },
            {
                "name": "error",
                "label": "error",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "ingress",
                "label": "Ingress",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    }
}

PUT Upload BLOB

Upload BLOB is a callback URL returned from Upload Files API, which uploads a file to a bucket.

Body Params is form-data type

Body Params Description Type Required Format
content File Path File Yes
callBackURL callbackUrl you receive from the Upload File API Response String Yes
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Status200
Access-Control-Allow-Origin*
Content-Length76
Content-Typeapplication/json; charset=utf-8
DateThu, 08 Dec 2022 07:12:15 GMT
ServerEDJX
Traceparent00-a17f09241e01a11222aeb8b9e3a1ae46-c4f75c1e83ebff39-01
X-Correlation-Ida17f09241e01a11222aeb8b9e3a1ae46
Sample request
Upload BLOB
curl -X PUT -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -F "callBackURL=https://https://api.edjx.net/api/buckets/36ca629d-2168-4b4c-b130-97948e8f1bcf/uploads/d5de45aa-442d-4854-a117-049ecae5a036" -F "content=abc.png" "https://36ca629d-2168-4b4c-b130-97948e8f1bcf--ttngj.storage.edjx.net/blobs/abc.png"
PUT /blobs/abc.png HTTP/1.1
Host: 36ca629d-2168-4b4c-b130-97948e8f1bcf--ttngj.storage.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="callBackURL"

https://https://api.edjx.net/api/buckets/36ca629d-2168-4b4c-b130-97948e8f1bcf/uploads/d5de45aa-442d-4854-a117-049ecae5a036
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="content"

abc.png
----WebKitFormBoundary7MA4YWxkTrZu0gW
{
    "cid": "1AYsj61MRCpU3xGrbHmwkRzEuWfHWDnP18nqbPP1p4EDjb",
    "status": "success"
}

GET Read All Files

Displays a list of files in the current bucket.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length3684
Content-Typeapplication/json; charset=utf-8
DateFri, 11 Nov 2022 09:09:40 GMT
EtagW/"e64-RNS0vJ2RXzuCaH9pAX2lljSfCbQ"
ServerEDJX
Traceparent00-fa167912f8d16da1e9b6e2197f21a1c8-f1c9e8a6ffc44f48-01
X-Corelation-Idfa167912f8d16da1e9b6e2197f21a1c8
X-Powered-ByExpress
Sample request
Read All Files
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/buckets/:bucketId/files"
GET /api/buckets/:bucketId/files HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": "1",
    "first": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": null,
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files?page=1",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "total": "1"
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension",
            "id": "000g0000-0a0b-0a0d-bbbb-0000000h0002",
            "name": "yourFileName.extension",
            "size": 10,
            "versionSize": 15,
            "headers": [],
            "bucket": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "name": "auto_11-Nov-2022_8_25_49",
                "versioning": true,
                "isPublic": true,
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "defaultVersion": "100g0000-0a0b-0a0d-bbbb-0000000h0002",
            "organization": {
                "id": "001g0000-0a0b-0a0d-bbbb-0000000h0002",
                "name": "TestOrg",
                "href": "https://api.edjx.net/api/organizations/001g0000-0a0b-0a0d-bbbb-0000000h0002"
            },
            "stats": {
                "downloads": {
                    "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads?fileId=000g0000-0a0b-0a0d-bbbb-0000000h0002",
                    "rel": [
                        "collection"
                    ],
                    "count": "0"
                }
            },
            "versions": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/versions",
                "rel": [
                    "collection"
                ]
            },
            "createdBy": {
                "id": "001g0000-0a0b-0a0d-bbbb-0000000h0001",
                "href": "https://api.edjx.net/api/users/001g0000-0a0b-0a0d-bbbb-0000000h0001"
            },
            "createdAt": "2022-11-11T08:25:52.000Z",
            "updatedAt": "2022-11-11T08:25:56.142Z",
            "activities": {
                "href": "https://api.edjx.net/api/activities?resource=bucket&resourceId=000g0000-0a0b-0a0d-bbbb-0000000h0002",
                "rel": [
                    "collection"
                ]
            },
            "delete": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension",
                "method": "DELETE"
            },
            "signedUrl": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/signedUrl",
                "method": "GET"
            },
            "update": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "id",
                        "label": "ID",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "headers",
                        "label": "Headers",
                        "type": "array",
                        "enabled": true
                    },
                    {
                        "name": "defaultVersion",
                        "label": "Default Version",
                        "type": "string",
                        "enabled": true
                    }
                ]
            }
        }
    ],
    "upload": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/uploads",
        "rel": [
            "form"
        ],
        "method": "POST",
        "produces": "application/json+ion",
        "value": [
            {
                "name": "name",
                "label": "File Path",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "options",
                "label": "Options",
                "type": "array",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "properties",
                "label": "Properties",
                "type": "array",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "cid",
                "label": "CID",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "rootBlockId",
                "label": "rootBlockId",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "size",
                "label": "Size",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            },
            {
                "name": "status",
                "label": "status",
                "type": "string",
                "enabled": true,
                "required": false,
                "visible": false,
                "options": [
                    {
                        "label": "uploading",
                        "value": "uploading"
                    },
                    {
                        "label": "success",
                        "value": "success"
                    },
                    {
                        "label": "failed",
                        "value": "failed"
                    }
                ]
            },
            {
                "name": "ingress",
                "label": "Ingress",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    }
}

GET Read File Metadata

Displays the details of a specific file.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Status200
Access-Control-Allow-Origin*
Content-Length2197
Content-Typeapplication/json; charset=utf-8
DateFri, 11 Nov 2022 09:09:51 GMT
EtagW/"895-+H9go2f6RIDwZhEXhwUudHIp0YI"
ServerEDJX
Traceparent00-d52ea9b57e2e90608e182ebafc948142-4ccbc5b4323ea3f6-01
X-Corelation-Idd52ea9b57e2e90608e182ebafc948142
X-Powered-ByExpress
Sample request
Read File Metadata
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" "https://api.edjx.net/api/buckets/:bucketId/files/:fileName"
GET /api/buckets/:bucketId/files/:fileName HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
{
    "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension",
    "id": "200g0000-0a0b-0a0d-bbbb-0000000h0000",
    "name": "yourFileName.extension",
    "size": 10,
    "versionSize": 15,
    "headers": [],
    "url": "https://000g0000-0a0b-0a0d-bbbb-0000000h0000.storage.edjx.net/blobs/yourFileName.extension",
    "bucket": {
        "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "name": "auto_11-Nov-2022_8_25_49",
        "versioning": true,
        "isPublic": true,
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "defaultVersion": "DEFAULT_VERSION",
    "organization": {
        "id": "000g0000-0a0b-0a0d-bbbb-0000000h0100",
        "name": "TestOrg",
        "href": "https://api.edjx.net/api/organizations/000g0000-0a0b-0a0d-bbbb-0000000h0100"
    },
    "stats": {
        "downloads": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads?fileId=200g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": "0"
        }
    },
    "versions": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/versions",
        "rel": [
            "collection"
        ]
    },
    "createdBy": {
        "id": "400g0000-0a0b-0a0d-bbbb-0000000h0100",
        "href": "https://api.edjx.net/api/users/400g0000-0a0b-0a0d-bbbb-0000000h0100"
    },
    "createdAt": "2022-11-11T08:25:52.000Z",
    "updatedAt": "2022-11-11T08:25:56.142Z",
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=bucket&resourceId=200g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "collection"
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension",
        "method": "DELETE"
    },
    "signedUrl": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/signedUrl",
        "method": "GET"
    },
    "update": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "headers",
                "label": "Headers",
                "type": "array",
                "enabled": true
            },
            {
                "name": "defaultVersion",
                "label": "Default Version",
                "type": "string",
                "enabled": true
            }
        ]
    }
}

PUT Update File Metadata

Updates the metadata of a specific file.

Body Params

Body Params Description Type Required Format
defaultVersion ID of the version to download. Default is the current version. string Yes Minimum 2 characters are required
headers Vertical Bar separated string of custom headers in the form of header::value.
Enclose the string in double quotes.
string Yes
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length1933
Content-Typeapplication/json; charset=utf-8
DateFri, 11 Nov 2022 19:07:59 GMT
EtagW/"78d-SXXICy7IWVhP9q5r5gcKQRC74Rg"
ServerEDJX
Traceparent00-4d71977b02903868ea5cf21b8dca0f14-620f675e75b211da-01
X-Corelation-Id4d71977b02903868ea5cf21b8dca0f14
X-Powered-ByExpress
Sample request
Update File Metadata
curl -X PUT -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
    "defaultVersion": "DEFAULT_VERSION",
    "headers": [{
        "key": "Content-Type",
        "value": "{{UPDATED_KEY_VALUE}}"
    },
    {
        "key": "Content-Disposition",
        "value": "test"
    }]
}' "https://api.edjx.net/api/buckets/:bucketId/files/:fileName"
PUT /api/buckets/:bucketId/files/:fileName HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
    "defaultVersion": "DEFAULT_VERSION",
    "headers": [{
        "key": "Content-Type",
        "value": "{{UPDATED_KEY_VALUE}}"
    },
    {
        "key": "Content-Disposition",
        "value": "test"
    }]
}
{
    "href": "https://api.edjx.net/api/bucket/100g0001-0a0b-0a0d-bbbb-0000000h0100/files/yourFileName.extension",
    "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
    "name": "yourFileName.extension",
    "size": 84624,
    "versionSize": 84624,
    "headers": [
        {
            "key": "Content-Type",
            "value": "{{UPDATED_KEY_VALUE}}"
        },
        {
            "key": "Content-Disposition",
            "value": "tt"
        }
    ],
    "bucket": {
        "href": "https://api.edjx.net/api/bucket/100g0001-0a0b-0a0d-bbbb-0000000h0100"
    },
    "defaultVersion": "DEFAULT_VERSION",
    "organization": {
        "href": "https://api.edjx.net/api/organizations/c5ef1668-7723-4eb6-a5ae-bc95caa76268"
    },
    "stats": {
        "downloads": {
            "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads?fileId=000g0000-0a0b-0a0d-bbbb-0000000h0000",
            "rel": [
                "collection"
            ],
            "count": "0"
        }
    },
    "versions": {
        "href": "https://api.edjx.net/api/bucket/100g0001-0a0b-0a0d-bbbb-0000000h0100/files/yourFileName.extension/versions",
        "rel": [
            "collection"
        ]
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/3ad71999-2069-406d-a51a-f7796f762c7a"
    },
    "createdAt": "2022-11-11T19:06:09.000Z",
    "updatedAt": "2022-11-11T19:07:58.276Z",
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=bucket&resourceId=000g0000-0a0b-0a0d-bbbb-0000000h0000",
        "rel": [
            "collection"
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/bucket/100g0001-0a0b-0a0d-bbbb-0000000h0100/files/yourFileName.extension",
        "method": "DELETE"
    },
    "signedUrl": {
        "href": "https://api.edjx.net/api/bucket/100g0001-0a0b-0a0d-bbbb-0000000h0100/files/yourFileName.extension/signedUrl",
        "method": "GET"
    },
    "update": {
        "href": "https://api.edjx.net/api/bucket/100g0001-0a0b-0a0d-bbbb-0000000h0100/files/yourFileName.extension",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "headers",
                "label": "Headers",
                "type": "array",
                "enabled": true
            },
            {
                "name": "defaultVersion",
                "label": "Default Version",
                "type": "string",
                "enabled": true
            }
        ]
    }
}

GET Read File Versions

Lists all versions of a file in a bucket.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length2546
Content-Typeapplication/json; charset=utf-8
DateFri, 11 Nov 2022 09:11:46 GMT
EtagW/"9f2-zCsTnXrBAxUqtc0Tm50hSJMwLxU"
ServerEDJX
Traceparent00-6015b1d74cf5e23ec7081d8d21a07684-447cb4e0342699a9-01
X-Corelation-Id6015b1d74cf5e23ec7081d8d21a07684
X-Powered-ByExpress
Sample request
Read File Versions
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/buckets/:bucketId/files/:fileName/versions"
GET /api/buckets/:bucketId/files/:fileName/versions HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/versions",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 2,
    "first": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/versions?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": null,
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/versions?page=1",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "href": "https://api.edjx.net//api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/versions/431g0000-0a0b-0a0d-bbbb-0000000h0000",
            "id": "431g0000-0a0b-0a0d-bbbb-0000000h0000",
            "name": "1668155156146",
            "size": 10,
            "rootBlockId": "1AXcUmihsdqiypSVoF4eGTm3x5WYNpX12736Ya258k6vNy",
            "object": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension",
                "id": "db4a1c27-f6a1-4f54-95fc-98bd60dbb546"
            },
            "container": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "signedUrl": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/signedUrl?v=431g0000-0a0b-0a0d-bbbb-0000000h0000",
                "method": "GET"
            },
            "createdBy": {
                "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h1000"
            },
            "createdAt": "2022-11-11T08:25:56.146Z",
            "updatedAt": "2022-11-11T08:25:56.146Z"
        },
        {
            "href": "https://api.edjx.net//api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/versions/900g0000-0a0b-0a0d-bbbb-0000000h1000",
            "id": "900g0000-0a0b-0a0d-bbbb-0000000h1000",
            "name": "1668155152838",
            "size": 5,
            "rootBlockId": "1AWsmLP8WU7v1LdzWt1q1MixTCbA9pbgnW3xe1vY8R7j2N",
            "object": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension",
                "id": "db4a1c27-f6a1-4f54-95fc-98bd60dbb546"
            },
            "container": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "signedUrl": {
                "href": "https://api.edjx.net/api/buckets/000g0000-0a0b-0a0d-bbbb-0000000h0000/files/yourFileName.extension/signedUrl?v=900g0000-0a0b-0a0d-bbbb-0000000h1000",
                "method": "GET"
            },
            "createdBy": {
                "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h1000"
            },
            "createdAt": "2022-11-11T08:25:52.839Z",
            "updatedAt": "2022-11-11T08:25:52.839Z"
        }
    ]
}

DELETE Delete File

Deletes a specific file in a bucket.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length39
Content-Typeapplication/json; charset=utf-8
DateFri, 11 Nov 2022 09:12:02 GMT
EtagW/"27-mI592sWjY59tPHtGjE18QA5tXiQ"
ServerEDJX
Traceparent00-30ad9a508161a62ca10eb42854c65ba3-fdfd7bfba53d1b82-01
X-Corelation-Id30ad9a508161a62ca10eb42854c65ba3
X-Powered-ByExpress
Sample request
Delete File
curl -X DELETE -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/buckets/:bucketId/files/:fileName"
DELETE /api/buckets/:bucketId/files/:fileName HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "message": "File Deleted successfully"
}

Domains


The Domains APIs facilitate the management of domains for an account.

POST Create Domain

Creates a domain in an organization.

Body Params

Body Params Description Type Required Format
organization Organization UUID to associate with the domain UUID Yes
name Name of the domain string Yes Minimum 2 characters are required and a maximum of 128 characters are allowed, which includes only alphanumeric, hyphen, or underscore
description Description of the domain
boolean Yes If the description contains a string of alphabets/ numbers, the string MUST be in parenthesis, for example, “new domain”.
cname Sets the domain type to CNAME No
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length3796
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 09:04:42 GMT
EtagW/"ed4-SiyZ+66ANAvMtt1C8FbiVfRjc9I"
ServerEDJX
Traceparent00-192236492dc8697823eca53375a8dbba-ffc8fdde32698ca8-01
X-Corelation-Id192236492dc8697823eca53375a8dbba
X-Powered-ByExpress
Sample request
Create Domain
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{ 
    "name": "your.domain.name",
    "description": "great domain",
    "organization": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "cname":false
}
' "https://api.edjx.net/api/domains"
POST /api/domains HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{ 
    "name": "your.domain.name",
    "description": "great domain",
    "organization": "374c1c04-5748-40cb-989a-ca1a389de33f",
    "cname":false
}
{
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000",
    "id": "000g0000-0a0b-0a0d-bbbb-0000000h1000",
    "name": "your.domain.name",
    "type": "full",
    "status": "verified",
    "description": "great domain",
    "compression": {
        "isEnabled": true,
        "isBrotliEnabled": false,
        "extensions": [
            "css",
            "js",
            "html",
            "eot",
            "ico",
            "otf",
            "ttf",
            "json",
            "svg"
        ],
        "contentTypes": [
            "text/html",
            "text/richtext",
            "text/plain",
            "text/css",
            "text/x-script",
            "text/x-component",
            "text/x-java-source",
            "text/x-markdown",
            "application/javascript",
            "application/x-javascript",
            "text/javascript",
            "text/js",
            "image/x-icon",
            "image/vnd.microsoft.icon",
            "application/x-perl",
            "application/x-httpd-cgi",
            "text/xml",
            "application/xml",
            "application/xml+rss",
            "application/vnd.api+json",
            "application/x-protobuf",
            "application/json",
            "multipart/bag",
            "multipart/mixed",
            "application/xhtml+xml",
            "font/ttf",
            "font/otf",
            "font/x-woff",
            "image/svg+xml",
            "application/vnd.ms-fontobject",
            "application/ttf",
            "application/x-ttf",
            "application/otf",
            "application/x-otf",
            "application/truetype",
            "application/opentype",
            "application/x-opentype",
            "application/font-woff",
            "application/eot",
            "application/font",
            "application/font-sfnt",
            "application/wasm",
            "application/javascript-binast",
            "application/manifest+json",
            "application/ld+json"
        ]
    },
    "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "records": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/records",
        "rel": [
            "collection"
        ]
    },
    "rules": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/rules",
        "rel": [
            "collection"
        ]
    },
    "certificates": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/certificates",
        "rel": [
            "collection"
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=domain&resourceId=000g0000-0a0b-0a0d-bbbb-0000000h1000",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/summary"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/889g0000-0a0b-0a0d-bbbb-0000000h1000"
    },
    "createdAt": "2022-11-09T09:04:42.693Z",
    "updatedAt": "2022-11-09T09:04:42.693Z",
    "delete": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000",
        "method": "DELETE"
    },
    "startCachePurge": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/cachePurges",
        "method": "POST"
    },
    "update": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "pattern": {},
                "enabled": false,
                "required": false,
                "visible": true
            },
            {
                "name": "type",
                "label": "Type",
                "type": "string",
                "options": [
                    {
                        "label": "CNAME",
                        "value": "cname"
                    },
                    {
                        "label": "Full",
                        "value": "full"
                    }
                ],
                "enabled": false,
                "required": false,
                "visible": true
            },
            {
                "name": "description",
                "label": "Description",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "compression",
                "label": "Compression",
                "type": "object",
                "enabled": true,
                "required": false,
                "visible": false,
                "form": {
                    "value": [
                        {
                            "name": "isEnabled",
                            "label": "Enable Compression",
                            "type": "boolean",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "isBrotliEnabled",
                            "label": "Enable Brotli",
                            "type": "boolean",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "extensions",
                            "label": "Extensions",
                            "type": "array",
                            "etype": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "contentTypes",
                            "label": "Content Types",
                            "type": "array",
                            "etype": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        }
                    ]
                }
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "pattern": {},
                "enabled": false,
                "required": false,
                "visible": true
            }
        ]
    }
}

GET Read Domain

Gets all the details for a specific domain.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length4034
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 10:28:24 GMT
EtagW/"fc2-q82evr+c80IT2w3ugwb6ZuvUbII"
ServerEDJX
Traceparent00-e57b8f9da6dcfe8a169c6433bddeb1c5-bf55343a7c0e6911-01
X-Corelation-Ide57b8f9da6dcfe8a169c6433bddeb1c5
X-Powered-ByExpress
Sample request
Read Domain
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId"
GET /api/domains/:domainId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000",
    "id": "000g0000-0a0b-0a0d-bbbb-0000000h1000",
    "name": "your.domain.name",
    "type": "full",
    "status": "verified",
    "description": "great domain",
    "compression": {
        "isEnabled": true,
        "isBrotliEnabled": false,
        "extensions": [
            "css",
            "js",
            "html",
            "eot",
            "ico",
            "otf",
            "ttf",
            "json",
            "svg"
        ],
        "contentTypes": [
            "text/html",
            "text/richtext",
            "text/plain",
            "text/css",
            "text/x-script",
            "text/x-component",
            "text/x-java-source",
            "text/x-markdown",
            "application/javascript",
            "application/x-javascript",
            "text/javascript",
            "text/js",
            "image/x-icon",
            "image/vnd.microsoft.icon",
            "application/x-perl",
            "application/x-httpd-cgi",
            "text/xml",
            "application/xml",
            "application/xml+rss",
            "application/vnd.api+json",
            "application/x-protobuf",
            "application/json",
            "multipart/bag",
            "multipart/mixed",
            "application/xhtml+xml",
            "font/ttf",
            "font/otf",
            "font/x-woff",
            "image/svg+xml",
            "application/vnd.ms-fontobject",
            "application/ttf",
            "application/x-ttf",
            "application/otf",
            "application/x-otf",
            "application/truetype",
            "application/opentype",
            "application/x-opentype",
            "application/font-woff",
            "application/eot",
            "application/font",
            "application/font-sfnt",
            "application/wasm",
            "application/javascript-binast",
            "application/manifest+json",
            "application/ld+json"
        ]
    },
    "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "records": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/records",
        "rel": [
            "collection"
        ]
    },
    "rules": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/rules",
        "rel": [
            "collection"
        ]
    },
    "certificates": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/certificates",
        "rel": [
            "collection"
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=domain&resourceId=000g0000-0a0b-0a0d-bbbb-0000000h1000",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/summary"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/889g0000-0a0b-0a0d-bbbb-0000000h1000"
    },
    "createdAt": "2022-11-09T09:04:42.693Z",
    "updatedAt": "2022-11-09T09:04:42.693Z",
    "delete": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000",
        "method": "DELETE"
    },
    "startCachePurge": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000/cachePurges",
        "method": "POST"
    },
    "update": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h1000",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "pattern": {},
                "enabled": false,
                "required": false,
                "visible": true
            },
            {
                "name": "type",
                "label": "Type",
                "type": "string",
                "options": [
                    {
                        "label": "CNAME",
                        "value": "cname"
                    },
                    {
                        "label": "Full",
                        "value": "full"
                    }
                ],
                "enabled": false,
                "required": false,
                "visible": true
            },
            {
                "name": "description",
                "label": "Description",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "compression",
                "label": "Compression",
                "type": "object",
                "enabled": true,
                "required": false,
                "visible": false,
                "form": {
                    "value": [
                        {
                            "name": "isEnabled",
                            "label": "Enable Compression",
                            "type": "boolean",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "isBrotliEnabled",
                            "label": "Enable Brotli",
                            "type": "boolean",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "extensions",
                            "label": "Extensions",
                            "type": "array",
                            "etype": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "contentTypes",
                            "label": "Content Types",
                            "type": "array",
                            "etype": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        }
                    ]
                }
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "pattern": {},
                "enabled": false,
                "required": false,
                "visible": true
            }
        ]
    }
}

GET Read All Domains

Lists all domains associated with the user.

Content-Typeapplication/json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length41352
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 09:04:19 GMT
EtagW/"a188-Hd1kTushzPQLSmm5BN4smRn1HE4"
ServerEDJX
Traceparent00-fa542a6be4f8417f0d00e0b397a67471-cd9371d3735ffba6-01
X-Corelation-Idfa542a6be4f8417f0d00e0b397a67471
X-Powered-ByExpress
Sample request
Read All Domains
curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains"
GET /api/domains HTTP/1.1
Host: api.edjx.net
Content-Type: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/domains",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 2,
    "first": {
        "href": "https://api.edjx.net/api/domains?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": {
        "href": "https://api.edjx.net/api/domains?page=2",
        "rel": [
            "collection"
        ]
    },
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/domains?page=19",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/domains/889g0000-0a0b-0a0d-bbbb-0000000h1000",
            "id": "889g0000-0a0b-0a0d-bbbb-0000000h1000",
            "name": "www.exampledomain.org",
            "type": "full",
            "status": "verified",
            "description": "example domain",
            "compression": {
                "isEnabled": true,
                "isBrotliEnabled": false,
                "extensions": [
                    "css",
                    "js",
                    "html",
                    "eot",
                    "ico",
                    "otf",
                    "ttf",
                    "json",
                    "svg"
                ],
                "contentTypes": [
                    "text/html",
                    "text/richtext",
                    "text/plain",
                    "text/css",
                    "text/x-script",
                    "text/x-component",
                    "text/x-java-source",
                    "text/x-markdown",
                    "application/javascript",
                    "application/x-javascript",
                    "text/javascript",
                    "text/js",
                    "image/x-icon",
                    "image/vnd.microsoft.icon",
                    "application/x-perl",
                    "application/x-httpd-cgi",
                    "text/xml",
                    "application/xml",
                    "application/xml+rss",
                    "application/vnd.api+json",
                    "application/x-protobuf",
                    "application/json",
                    "multipart/bag",
                    "multipart/mixed",
                    "application/xhtml+xml",
                    "font/ttf",
                    "font/otf",
                    "font/x-woff",
                    "image/svg+xml",
                    "application/vnd.ms-fontobject",
                    "application/ttf",
                    "application/x-ttf",
                    "application/otf",
                    "application/x-otf",
                    "application/truetype",
                    "application/opentype",
                    "application/x-opentype",
                    "application/font-woff",
                    "application/eot",
                    "application/font",
                    "application/font-sfnt",
                    "application/wasm",
                    "application/javascript-binast",
                    "application/manifest+json",
                    "application/ld+json"
                ]
            },
            "organization": {
                "id": "567g0000-0a0b-0a0d-bbbb-0000000h1000",
                "name": "TestOrg",
                "href": "https://api.edjx.net/api/organizations/567g0000-0a0b-0a0d-bbbb-0000000h1000"
            },
            "records": {
                "href": "https://api.edjx.net/api/domains/889g0000-0a0b-0a0d-bbbb-0000000h1000/records",
                "rel": [
                    "collection"
                ],
                "size": 3
            },
            "rules": {
                "href": "https://api.edjx.net/api/domains/889g0000-0a0b-0a0d-bbbb-0000000h1000/rules",
                "rel": [
                    "collection"
                ],
                "size": 0
            },
            "certificates": {
                "href": "https://api.edjx.net/api/domains/889g0000-0a0b-0a0d-bbbb-0000000h1000/certificates",
                "rel": [
                    "collection"
                ],
                "size": 0
            },
            "activities": {
                "href": "https://api.edjx.net/api/activities?resource=domain&resourceId=889g0000-0a0b-0a0d-bbbb-0000000h1000",
                "rel": [
                    "collection"
                ]
            },
            "summary": {
                "href": "https://api.edjx.net/api/domains/889g0000-0a0b-0a0d-bbbb-0000000h1000/summary"
            },
            "createdBy": {
                "id": "001g0002-0a0b-0a0d-bbbb-0000000h1000",
                "name": "example name",
                "email": "foo@example.com",
                "photoUrl": null,
                "href": "https://api.edjx.net/api/users/001g0002-0a0b-0a0d-bbbb-0000000h1000"
            },
            "createdAt": "2022-11-07T06:54:37.871Z",
            "updatedAt": "2022-11-07T06:54:37.871Z",
            "delete": {
                "href": "https://api.edjx.net/api/domains/889g0000-0a0b-0a0d-bbbb-0000000h1000",
                "method": "DELETE"
            },
            "startCachePurge": {
                "href": "https://api.edjx.net/api/domains/889g0000-0a0b-0a0d-bbbb-0000000h1000/cachePurges",
                "method": "POST"
            },
            "update": {
                "href": "https://api.edjx.net/api/domains/889g0000-0a0b-0a0d-bbbb-0000000h1000",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "id",
                        "label": "ID",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "pattern": {},
                        "enabled": false,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "type",
                        "label": "Type",
                        "type": "string",
                        "options": [
                            {
                                "label": "CNAME",
                                "value": "cname"
                            },
                            {
                                "label": "Full",
                                "value": "full"
                            }
                        ],
                        "enabled": false,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "compression",
                        "label": "Compression",
                        "type": "object",
                        "enabled": true,
                        "required": false,
                        "visible": false,
                        "form": {
                            "value": [
                                {
                                    "name": "isEnabled",
                                    "label": "Enable Compression",
                                    "type": "boolean",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                },
                                {
                                    "name": "isBrotliEnabled",
                                    "label": "Enable Brotli",
                                    "type": "boolean",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                },
                                {
                                    "name": "extensions",
                                    "label": "Extensions",
                                    "type": "array",
                                    "etype": "string",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                },
                                {
                                    "name": "contentTypes",
                                    "label": "Content Types",
                                    "type": "array",
                                    "etype": "string",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                }
                            ]
                        }
                    },
                    {
                        "name": "organization",
                        "label": "Organization",
                        "type": "string",
                        "pattern": {},
                        "enabled": false,
                        "required": false,
                        "visible": true
                    }
                ]
            }
        },
        {
            "href": "https://api.edjx.net/api/domains/857g0000-0a0b-0a0d-bbbb-0000000h1000",
            "id": "857g0000-0a0b-0a0d-bbbb-0000000h1000",
            "name": "www.exampledomain2.biz",
            "type": "full",
            "status": "verified",
            "description": "example domain 2",
            "compression": {
                "isEnabled": true,
                "isBrotliEnabled": false,
                "extensions": [
                    "css",
                    "js",
                    "html",
                    "eot",
                    "ico",
                    "otf",
                    "ttf",
                    "json",
                    "svg"
                ],
                "contentTypes": [
                    "text/html",
                    "text/richtext",
                    "text/plain",
                    "text/css",
                    "text/x-script",
                    "text/x-component",
                    "text/x-java-source",
                    "text/x-markdown",
                    "application/javascript",
                    "application/x-javascript",
                    "text/javascript",
                    "text/js",
                    "image/x-icon",
                    "image/vnd.microsoft.icon",
                    "application/x-perl",
                    "application/x-httpd-cgi",
                    "text/xml",
                    "application/xml",
                    "application/xml+rss",
                    "application/vnd.api+json",
                    "application/x-protobuf",
                    "application/json",
                    "multipart/bag",
                    "multipart/mixed",
                    "application/xhtml+xml",
                    "font/ttf",
                    "font/otf",
                    "font/x-woff",
                    "image/svg+xml",
                    "application/vnd.ms-fontobject",
                    "application/ttf",
                    "application/x-ttf",
                    "application/otf",
                    "application/x-otf",
                    "application/truetype",
                    "application/opentype",
                    "application/x-opentype",
                    "application/font-woff",
                    "application/eot",
                    "application/font",
                    "application/font-sfnt",
                    "application/wasm",
                    "application/javascript-binast",
                    "application/manifest+json",
                    "application/ld+json"
                ]
            },
            "organization": {
                "id": "567g0000-0a0b-0a0d-bbbb-0000000h1000",
                "name": "TestOrg",
                "href": "https://api.edjx.net/api/organizations/567g0000-0a0b-0a0d-bbbb-0000000h1000"
            },
            "records": {
                "href": "https://api.edjx.net/api/domains/857g0000-0a0b-0a0d-bbbb-0000000h1000/records",
                "rel": [
                    "collection"
                ],
                "size": 3
            },
            "rules": {
                "href": "https://api.edjx.net/api/domains/857g0000-0a0b-0a0d-bbbb-0000000h1000/rules",
                "rel": [
                    "collection"
                ],
                "size": 0
            },
            "certificates": {
                "href": "https://api.edjx.net/api/domains/857g0000-0a0b-0a0d-bbbb-0000000h1000/certificates",
                "rel": [
                    "collection"
                ],
                "size": 0
            },
            "activities": {
                "href": "https://api.edjx.net/api/activities?resource=domain&resourceId=857g0000-0a0b-0a0d-bbbb-0000000h1000",
                "rel": [
                    "collection"
                ]
            },
            "summary": {
                "href": "https://api.edjx.net/api/domains/857g0000-0a0b-0a0d-bbbb-0000000h1000/summary"
            },
            "createdBy": {
                "id": "001g0002-0a0b-0a0d-bbbb-0000000h1000",
                "name": "",
                "email": "",
                "photoUrl": null,
                "href": "https://api.edjx.net/api/users/001g0002-0a0b-0a0d-bbbb-0000000h1000"
            },
            "createdAt": "2022-11-07T06:54:00.505Z",
            "updatedAt": "2022-11-07T06:54:00.505Z",
            "delete": {
                "href": "https://api.edjx.net/api/domains/857g0000-0a0b-0a0d-bbbb-0000000h1000",
                "method": "DELETE"
            },
            "startCachePurge": {
                "href": "https://api.edjx.net/api/domains/857g0000-0a0b-0a0d-bbbb-0000000h1000/cachePurges",
                "method": "POST"
            },
            "update": {
                "href": "https://api.edjx.net/api/domains/857g0000-0a0b-0a0d-bbbb-0000000h1000",
                "rel": [
                    "edit-form"
                ],
                "method": "PUT",
                "value": [
                    {
                        "name": "id",
                        "label": "ID",
                        "type": "string",
                        "enabled": false,
                        "visible": true
                    },
                    {
                        "name": "name",
                        "label": "Name",
                        "type": "string",
                        "pattern": {},
                        "enabled": false,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "type",
                        "label": "Type",
                        "type": "string",
                        "options": [
                            {
                                "label": "CNAME",
                                "value": "cname"
                            },
                            {
                                "label": "Full",
                                "value": "full"
                            }
                        ],
                        "enabled": false,
                        "required": false,
                        "visible": true
                    },
                    {
                        "name": "description",
                        "label": "Description",
                        "type": "string",
                        "enabled": true,
                        "required": true,
                        "visible": true
                    },
                    {
                        "name": "compression",
                        "label": "Compression",
                        "type": "object",
                        "enabled": true,
                        "required": false,
                        "visible": false,
                        "form": {
                            "value": [
                                {
                                    "name": "isEnabled",
                                    "label": "Enable Compression",
                                    "type": "boolean",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                },
                                {
                                    "name": "isBrotliEnabled",
                                    "label": "Enable Brotli",
                                    "type": "boolean",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                },
                                {
                                    "name": "extensions",
                                    "label": "Extensions",
                                    "type": "array",
                                    "etype": "string",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                },
                                {
                                    "name": "contentTypes",
                                    "label": "Content Types",
                                    "type": "array",
                                    "etype": "string",
                                    "enabled": true,
                                    "required": true,
                                    "visible": true
                                }
                            ]
                        }
                    },
                    {
                        "name": "organization",
                        "label": "Organization",
                        "type": "string",
                        "pattern": {},
                        "enabled": false,
                        "required": false,
                        "visible": true
                    }
                ]
            }
        }
    ],
    "create": {
        "href": "https://api.edjx.net/api/domains",
        "rel": [
            "create-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "cname",
                "label": "CNAME",
                "type": "boolean",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "description",
                "label": "Description",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            }
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=domain"
    }
}

PUT Update Domain

Updates the details of a domain.

Body Params

Body Params Description Type Required Format
description Description of the domain string Yes If the description contains a string of alphabets/ numbers, the string MUST be in parenthesis, for example, “new domain”.
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length3788
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 10:28:48 GMT
EtagW/"ecc-zWQ50pj6aQEk3Yb/1E1W9bJdsRY"
ServerEDJX
Traceparent00-e51cd7a6dc01ea76f3347249283c5bf0-c696ff0308964c56-01
X-Corelation-Ide51cd7a6dc01ea76f3347249283c5bf0
X-Powered-ByExpress
Sample request
Update Domain
curl -X PUT -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
   "description": "updated domain description example"
}' "https://api.edjx.net/api/domains/:domainId"
PUT /api/domains/:domainId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
   "description": "updated domain description example"
}
{
    "href": "https://api.edjx.net/api/domains/101g0002-0a0b-0a0d-bbbb-0000000h1000",
    "id": "101g0002-0a0b-0a0d-bbbb-0000000h1000",
    "name": "your.domain.name",
    "type": "full",
    "status": "verified",
    "description": "updated domain description example",
    "compression": {
        "isEnabled": true,
        "isBrotliEnabled": false,
        "extensions": [
            "css",
            "js",
            "html",
            "eot",
            "ico",
            "otf",
            "ttf",
            "json",
            "svg"
        ],
        "contentTypes": [
            "text/html",
            "text/richtext",
            "text/plain",
            "text/css",
            "text/x-script",
            "text/x-component",
            "text/x-java-source",
            "text/x-markdown",
            "application/javascript",
            "application/x-javascript",
            "text/javascript",
            "text/js",
            "image/x-icon",
            "image/vnd.microsoft.icon",
            "application/x-perl",
            "application/x-httpd-cgi",
            "text/xml",
            "application/xml",
            "application/xml+rss",
            "application/vnd.api+json",
            "application/x-protobuf",
            "application/json",
            "multipart/bag",
            "multipart/mixed",
            "application/xhtml+xml",
            "font/ttf",
            "font/otf",
            "font/x-woff",
            "image/svg+xml",
            "application/vnd.ms-fontobject",
            "application/ttf",
            "application/x-ttf",
            "application/otf",
            "application/x-otf",
            "application/truetype",
            "application/opentype",
            "application/x-opentype",
            "application/font-woff",
            "application/eot",
            "application/font",
            "application/font-sfnt",
            "application/wasm",
            "application/javascript-binast",
            "application/manifest+json",
            "application/ld+json"
        ]
    },
    "organization": {
        "href": "https://api.edjx.net/api/organizations/601g0002-0a0b-0a0d-bbbb-0000000h1000"
    },
    "records": {
        "href": "https://api.edjx.net/api/domains/101g0002-0a0b-0a0d-bbbb-0000000h1000/records",
        "rel": [
            "collection"
        ]
    },
    "rules": {
        "href": "https://api.edjx.net/api/domains/101g0002-0a0b-0a0d-bbbb-0000000h1000/rules",
        "rel": [
            "collection"
        ]
    },
    "certificates": {
        "href": "https://api.edjx.net/api/domains/101g0002-0a0b-0a0d-bbbb-0000000h1000/certificates",
        "rel": [
            "collection"
        ]
    },
    "activities": {
        "href": "https://api.edjx.net/api/activities?resource=domain&resourceId=101g0002-0a0b-0a0d-bbbb-0000000h1000",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "href": "https://api.edjx.net/api/domains/101g0002-0a0b-0a0d-bbbb-0000000h1000/summary"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/701g0002-0a0b-0a0d-bbbb-0000000h1000"
    },
    "createdAt": "2022-11-07T06:54:00.505Z",
    "updatedAt": "2022-11-09T10:28:40.776Z",
    "delete": {
        "href": "https://api.edjx.net/api/domains/101g0002-0a0b-0a0d-bbbb-0000000h1000",
        "method": "DELETE"
    },
    "startCachePurge": {
        "href": "https://api.edjx.net/api/domains/101g0002-0a0b-0a0d-bbbb-0000000h1000/cachePurges",
        "method": "POST"
    },
    "update": {
        "href": "https://api.edjx.net/api/domains/101g0002-0a0b-0a0d-bbbb-0000000h1000",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "id",
                "label": "ID",
                "type": "string",
                "enabled": false,
                "visible": true
            },
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "pattern": {},
                "enabled": false,
                "required": false,
                "visible": true
            },
            {
                "name": "type",
                "label": "Type",
                "type": "string",
                "options": [
                    {
                        "label": "CNAME",
                        "value": "cname"
                    },
                    {
                        "label": "Full",
                        "value": "full"
                    }
                ],
                "enabled": false,
                "required": false,
                "visible": true
            },
            {
                "name": "description",
                "label": "Description",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "compression",
                "label": "Compression",
                "type": "object",
                "enabled": true,
                "required": false,
                "visible": false,
                "form": {
                    "value": [
                        {
                            "name": "isEnabled",
                            "label": "Enable Compression",
                            "type": "boolean",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "isBrotliEnabled",
                            "label": "Enable Brotli",
                            "type": "boolean",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "extensions",
                            "label": "Extensions",
                            "type": "array",
                            "etype": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        },
                        {
                            "name": "contentTypes",
                            "label": "Content Types",
                            "type": "array",
                            "etype": "string",
                            "enabled": true,
                            "required": true,
                            "visible": true
                        }
                    ]
                }
            },
            {
                "name": "organization",
                "label": "Organization",
                "type": "string",
                "pattern": {},
                "enabled": false,
                "required": false,
                "visible": true
            }
        ]
    }
}

POST Purge Cache

Purges the cache for a specific domain.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length54
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 09:05:00 GMT
EtagW/"36-TA9w3SARfa3AikRdsn8KhykTU5E"
ServerEDJX
Traceparent00-97184139e8d16b7eba197b23decad8fe-930c15b268efffa0-01
X-Corelation-Id97184139e8d16b7eba197b23decad8fe
X-Powered-ByExpress
Sample request
Purge Cache
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/cachePurges"
POST /api/domains/:domainId/cachePurges HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "message": "Domain Cache purge started successfully."
}

POST Verify Domain

Starts the verification process for a CNAME domain type.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length57
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 10:34:03 GMT
EtagW/"39-XtDDdEkOmXqi/wPgNpg8UOaMiGQ"
ServerEDJX
Traceparent00-6886435b2cc57e62f3342b354dd98c6f-35ed0ef6e58d387c-01
X-Corelation-Id6886435b2cc57e62f3342b354dd98c6f
X-Powered-ByExpress
Sample request
Verify Domain
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/verify"
POST /api/domains/:domainId/verify HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "message": "Domain verification triggered successfully."
}

DELETE Delete Domain

Deletes a domain within an organization.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length41
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 10:32:51 GMT
EtagW/"29-elNGVztQ9DBRH3asRNSfYmJxtkw"
ServerEDJX
Traceparent00-b88344872b5c90fdca40c3fcf4b38d5d-2f61895be574afab-01
X-Corelation-Idb88344872b5c90fdca40c3fcf4b38d5d
X-Powered-ByExpress
Sample request
Delete Domain
curl -X DELETE -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId"
DELETE /api/domains/:domainId HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "message": "Domain Deleted successfully"
}

Records


DNS records are instructions in the authoritative DNS servers and provide information about a domain, such as the IP address associated with the domain and request handling for that domain. All DNS records have a ‘TTL’ (time-to-live) which indicates the frequency of refreshing a record by the DNS server.

POST Create Domain Record

Creates records of a specific domain type.

Body Params

Body Params Description Type Required Format
name Name of the domain record string Yes Maximum 128 characters are allowed, which includes only alphanumeric, hyphen, or underscore
type Sets the record type string Yes TXT , A ,AAAA ,NS ,MX , CNAME
target Sets the target value string Yes
ttl Sets the TTL value integer Yes
proxy Enables EDJX to be a proxy for this record
NOTE: Only caching will be active for this record when the proxy is enabled and no routing rules are configured.
boolean No true or false
priority Sets the priority level integer Yes, only for MX records
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length1932
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 14:11:35 GMT
EtagW/"78c-PKrELc48mQvTsBMrI16W54Bk358"
ServerEDJX
Traceparent00-293266b80bc3b965c549c042f6e6f2ea-59a7b9b1f88ec8a5-01
X-Corelation-Id293266b80bc3b965c549c042f6e6f2ea
X-Powered-ByExpress
Sample request
Create Domain Record
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
    "type": "A",
    "name": "record name",
    "target": "192.168.10.2",
    "description": "Added from postman APIs",
    "priority": "0",
    "proxy": "false",
    "ttl": "200"
}' "https://api.edjx.net/api/domains/:domainId/records"
POST /api/domains/:domainId/records HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
    "type": "A",
    "name": "record name",
    "target": "192.168.10.2",
    "description": "Added from postman APIs",
    "priority": "0",
    "proxy": "false",
    "ttl": "200"
}
{
    "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
    "id": "000g0002-0a0b-0a0d-bbbb-0000000h00093",
    "name": "record name",
    "type": "A",
    "target": "192.168.10.2",
    "cnameTarget": "",
    "ttl": "200",
    "proxy": false,
    "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "domain": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0089"
    },
    "updatedBy": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0089"
    },
    "createdAt": "2022-11-09T14:11:35.519Z",
    "updatedAt": "2022-11-09T14:11:35.519Z",
    "delete": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "type",
                "label": "Type",
                "type": "string",
                "options": [
                    {
                        "label": "A",
                        "value": "A"
                    },
                    {
                        "label": "AAAA",
                        "value": "AAAA"
                    },
                    {
                        "label": "NS",
                        "value": "NS"
                    },
                    {
                        "label": "MX",
                        "value": "MX"
                    },
                    {
                        "label": "TXT",
                        "value": "TXT"
                    },
                    {
                        "label": "CNAME",
                        "value": "CNAME"
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "ttl",
                "label": "TTL",
                "type": "number",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "target",
                "label": "Target",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "proxy",
                "label": "Proxy",
                "type": "boolean",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "priority",
                "label": "Priority",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    }
}

GET Read All Domain Records

Lists all DNS records for a domain.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length1417
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 14:11:23 GMT
EtagW/"589-/G377swX1gbSDOKAMmAqNAV/7AQ"
ServerEDJX
Traceparent00-f75282703b83a5140c7ebca6e37dfaf4-193bcf2e9a55fdcc-01
X-Corelation-Idf75282703b83a5140c7ebca6e37dfaf4
X-Powered-ByExpress
Sample request
Read All Domain Records
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/records"
GET /api/domains/:domainId/records HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0089/records",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 0,
    "first": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0089/records?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": null,
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0089/records?page=1",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "total": 0
    },
    "value": [],
    "create": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0089/records",
        "rel": [
            "create-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "type",
                "label": "Type",
                "type": "string",
                "options": [
                    {
                        "label": "A",
                        "value": "A"
                    },
                    {
                        "label": "AAAA",
                        "value": "AAAA"
                    },
                    {
                        "label": "NS",
                        "value": "NS"
                    },
                    {
                        "label": "MX",
                        "value": "MX"
                    },
                    {
                        "label": "TXT",
                        "value": "TXT"
                    },
                    {
                        "label": "CNAME",
                        "value": "CNAME"
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "ttl",
                "label": "TTL",
                "type": "number",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "target",
                "label": "Target",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "proxy",
                "label": "Proxy",
                "type": "boolean",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "priority",
                "label": "Priority",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    }
}

GET Read Domain Record

Gets the details for a specific record.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length2051
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 14:11:46 GMT
EtagW/"803-51t5p9aXG3ruc5yOKsrybuWPlKI"
ServerEDJX
Traceparent00-85a4c57c88499b3131ba2ef6142b9ecf-bb8936a80c3e9609-01
X-Corelation-Id85a4c57c88499b3131ba2ef6142b9ecf
X-Powered-ByExpress
Sample request
Read Domain Record
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/records/:recordId"
GET /api/domains/:domainId/records/:recordId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
    "id": "000g0002-0a0b-0a0d-bbbb-0000000h00093",
    "name": "record name",
    "type": "A",
    "target": "192.168.10.2",
    "cnameTarget": "",
    "ttl": "200",
    "proxy": false,
    "organization": {
        "href": "https://api.edjx.net/api/organizations/120g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "domain": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0089"
    },
    "updatedBy": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0089"
    },
    "createdAt": "2022-11-09T14:11:35.519Z",
    "updatedAt": "2022-11-09T14:11:35.519Z",
    "delete": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "type",
                "label": "Type",
                "type": "string",
                "options": [
                    {
                        "label": "A",
                        "value": "A"
                    },
                    {
                        "label": "AAAA",
                        "value": "AAAA"
                    },
                    {
                        "label": "NS",
                        "value": "NS"
                    },
                    {
                        "label": "MX",
                        "value": "MX"
                    },
                    {
                        "label": "TXT",
                        "value": "TXT"
                    },
                    {
                        "label": "CNAME",
                        "value": "CNAME"
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "ttl",
                "label": "TTL",
                "type": "number",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "target",
                "label": "Target",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "proxy",
                "label": "Proxy",
                "type": "boolean",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "priority",
                "label": "Priority",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    }
}

PUT Update Domain Record

Updates a specific record.

Body Params

Body Params Description Type Required Format
name Sets the new record name string Yes Maximum 128 characters are allowed, which includes only alphanumeric, hyphen, or underscore
type Sets the record type string Yes TXT , A ,AAAA ,NS ,MX , CNAME
target Sets the target value string Yes
ttl Sets the TTL value integer Yes
proxy Enables EDJX to be a proxy for this record.
NOTE: Only caching will be active for this record when the proxy is enabled and no routing rules are configured.
boolean No true or false
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length1933
Content-Typeapplication/json; charset=utf-8
DateThu, 10 Nov 2022 10:19:17 GMT
EtagW/"78d-fbEAyWNmNzyQq/MzelXvHyNc1Bc"
ServerEDJX
Traceparent00-9577341f5a272564b43303dfd3ebc51b-2463a4d0ef028982-01
X-Corelation-Id9577341f5a272564b43303dfd3ebc51b
X-Powered-ByExpress
Sample request
Update Domain Record
curl -X PUT -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{ 
    "name": "updated record name",
    "proxy": false,
    "type": "A",
    "ttl" : 300,
    "target" : "192.168.10.02"
}' "https://api.edjx.net/api/domains/:domainId/records/:recordId"
PUT /api/domains/:domainId/records/:recordId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{ 
    "name": "updated record name",
    "proxy": false,
    "type": "A",
    "ttl" : 300,
    "target" : "192.168.10.02"
}
{
    "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
    "id": "000g0002-0a0b-0a0d-bbbb-0000000h00093",
    "name": "updated record name",
    "type": "A",
    "target": "192.168.10.2",
    "cnameTarget": "",
    "ttl": "200",
    "proxy": false,
    "organization": {
        "href": "https://api.edjx.net/api/organizations/120g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "domain": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0089"
    },
    "updatedBy": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0089"
    },
    "createdAt": "2022-11-09T14:11:35.519Z",
    "updatedAt": "2022-11-09T14:11:35.519Z",
    "delete": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
        "method": "DELETE"
    },
    "update": {
        "href": "https://api.edjx.net/api/domains/000g0002-0a0b-0a0d-bbbb-0000000h0000/records/000g0002-0a0b-0a0d-bbbb-0000000h00093",
        "rel": [
            "edit-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "type",
                "label": "Type",
                "type": "string",
                "options": [
                    {
                        "label": "A",
                        "value": "A"
                    },
                    {
                        "label": "AAAA",
                        "value": "AAAA"
                    },
                    {
                        "label": "NS",
                        "value": "NS"
                    },
                    {
                        "label": "MX",
                        "value": "MX"
                    },
                    {
                        "label": "TXT",
                        "value": "TXT"
                    },
                    {
                        "label": "CNAME",
                        "value": "CNAME"
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "ttl",
                "label": "TTL",
                "type": "number",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "target",
                "label": "Target",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "proxy",
                "label": "Proxy",
                "type": "boolean",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "priority",
                "label": "Priority",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": false
            }
        ]
    }
}

DELETE Delete Domain Record

Deletes a record from a specific domain.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length45
Content-Typeapplication/json; charset=utf-8
DateThu, 10 Nov 2022 10:19:55 GMT
EtagW/"2d-MnC9H1mihUUToONUrgghzLtnvFo"
ServerEDJX
Traceparent00-387ca5c9506eb9bc22a055f2e25d8bb1-da2f55044eb001f2-01
X-Corelation-Id387ca5c9506eb9bc22a055f2e25d8bb1
X-Powered-ByExpress
Sample request
Delete Domain Record
curl -X DELETE -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/records/:recordId"
DELETE /api/domains/:domainId/records/:recordId HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "message": "DNS Record Deleted successfully"
}

Rules


Request Routing is a virtual service (virtual API) that forwards incoming requests to a Web service, receives a response, and transfers the response back to the client. Therefore, when routing is enabled, the virtual service functions as a transparent proxy between the client and the API.

POST Create Domain Rule

Creates rules for a domain.

Body Params

Body Params Description Type Required Format
name Sets the name of the rule string Yes
matchType Sets the routing match type string Yes Exact Match or Pattern Match
routingAction Default: {scheme}://{host}/{path}?{query} string Yes
proxyAction Sets the routing action value to redirect or rewrite Yes Redirect or Rewrite
value Sets the routing match type
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length2014
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 14:09:11 GMT
EtagW/"7de-DKmnm7eEvZSEMNckDV35KcDDnbc"
ServerEDJX
Traceparent00-1e0b98b9506d1af695d380a219dfe608-d67246bbd9e6fc9b-01
X-Corelation-Id1e0b98b9506d1af695d380a219dfe608
X-Powered-ByExpress
Sample request
Create Domain Rule
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
    "name": "{{ruleName}}",
    "matchType": "Pattern Match",
    "value": "https://api.edjx.test",
    "proxyAction": "Redirect",
    "routingAction": "{scheme}://{host}/{path}?{query}"
}' "https://api.edjx.net/api/domains/:domainId/rules"
POST /api/domains/:domainId/rules HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
    "name": "{{ruleName}}",
    "matchType": "Pattern Match",
    "value": "https://api.edjx.test",
    "proxyAction": "Redirect",
    "routingAction": "{scheme}://{host}/{path}?{query}"
}
{
    "href": "https://api.edjx.net/api/domains/100g0000-0a0b-0a0d-bbbb-0000000h0089/rules/120g0000-0a0b-0a0d-bbbb-0000000h0089",
    "id": "120g0000-0a0b-0a0d-bbbb-0000000h0089",
    "name": "{{ruleName}}",
    "value": "https://api.edjx.test",
    "order": 1,
    "matchType": "Pattern Match",
    "proxyAction": "Redirect",
    "routingAction": "{scheme}://{host}/{path}?{query}",
    "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "domain": {
        "href": "https://api.edjx.net/api/domains/100g0000-0a0b-0a0d-bbbb-0000000h0089"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "updatedBy": {
        "href": "https://api.edjx.net/api/users/000g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "createdAt": "2022-11-09T14:09:10.979Z",
    "updatedAt": "2022-11-09T14:09:10.979Z",
    "delete": {
        "href": "https://api.edjx.net/api/domains/100g0000-0a0b-0a0d-bbbb-0000000h0089/rules/120g0000-0a0b-0a0d-bbbb-0000000h0089",
        "method": "DELETE"
    },
    "update": {
        "rel": [
            "edit-form"
        ],
        "href": "https://api.edjx.net/api/domains/100g0000-0a0b-0a0d-bbbb-0000000h0089/rules/120g0000-0a0b-0a0d-bbbb-0000000h0089",
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "value",
                "label": "Match Value",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "matchType",
                "label": "Match Type",
                "type": "string",
                "options": [
                    {
                        "label": "Pattern Match",
                        "value": "Pattern Match"
                    },
                    {
                        "label": "Exact Match",
                        "value": "Exact Match"
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "proxyAction",
                "label": "Proxy Action",
                "type": "string",
                "options": [
                    {
                        "label": "Redirect",
                        "value": "Redirect"
                    },
                    {
                        "label": "Rewrite",
                        "value": "Rewrite"
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "routingAction",
                "label": "Routing Destination",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "order",
                "label": "Order",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": true
            }
        ]
    }
}

GET Read All Domain Rules

Lists all rules associated with a domain.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length1380
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 14:08:45 GMT
EtagW/"564-o2rHBIloFDQZ6gwfcJwcS41R5G4"
ServerEDJX
Traceparent00-c7de31627c230e28443a81044d1f3473-4ad08c1492582890-01
X-Corelation-Idc7de31627c230e28443a81044d1f3473
X-Powered-ByExpress
Sample request
Read All Domain Rules
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/rules"
GET /api/domains/:domainId/rules HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
  "self": {
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules",
    "rel": [
      "collection"
    ]
  },
  "offset": 0,
  "limit": 10,
  "size": 1,
  "first": {
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules?page=1",
    "rel": [
      "collection"
    ]
  },
  "next": null,
  "previous": null,
  "last": {
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules?page=1",
    "rel": [
      "collection"
    ]
  },
  "summary": {
    "total": 1
  },
  "value": [
    {
      "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules/000g0000-0a0b-0a0d-bbbb-0000000h0001",
      "id": "000g0000-0a0b-0a0d-bbbb-0000000h0001",
      "name": "{{ruleName}}",
      "value": "https://api.edjx.test",
      "order": 1,
      "matchType": "Pattern Match",
      "proxyAction": "Redirect",
      "routingAction": "{scheme}://{host}/{path}?{query}",
      "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
      },
      "domain": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000"
      },
      "createdBy": {
        "id": "bda2bcad-ed28-444c-a69a-6b06f9953b2f",
        "name": "example name",
        "email": "foo@example.com",
        "photoUrl": null,
        "href": "https://api.edjx.net/api/users/bda2bcad-ed28-444c-a69a-6b06f9953b2f"
      },
      "updatedBy": {
        "href": "https://api.edjx.net/api/users/bda2bcad-ed28-444c-a69a-6b06f9953b2f"
      },
      "createdAt": "2022-11-28T12:15:16.579Z",
      "updatedAt": "2022-11-28T12:15:16.579Z",
      "delete": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules/000g0000-0a0b-0a0d-bbbb-0000000h0001",
        "method": "DELETE"
      },
      "update": {
        "rel": [
          "edit-form"
        ],
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules/000g0000-0a0b-0a0d-bbbb-0000000h0001",
        "method": "PUT",
        "value": [
          {
            "name": "name",
            "pattern": {},
            "label": "Name",
            "type": "string",
            "enabled": true,
            "required": true,
            "visible": true
          },
          {
            "name": "value",
            "label": "Match Value",
            "type": "string",
            "enabled": true,
            "required": true,
            "visible": true
          },
          {
            "name": "matchType",
            "label": "Match Type",
            "type": "string",
            "options": [
              {
                "label": "Pattern Match",
                "value": "Pattern Match"
              },
              {
                "label": "Exact Match",
                "value": "Exact Match"
              }
            ],
            "enabled": true,
            "required": true,
            "visible": true
          },
          {
            "name": "proxyAction",
            "label": "Proxy Action",
            "type": "string",
            "options": [
              {
                "label": "Redirect",
                "value": "Redirect"
              },
              {
                "label": "Rewrite",
                "value": "Rewrite"
              }
            ],
            "enabled": true,
            "required": true,
            "visible": true
          },
          {
            "name": "routingAction",
            "label": "Routing Destination",
            "type": "string",
            "pattern": {},
            "enabled": true,
            "required": true,
            "visible": true
          },
          {
            "name": "order",
            "label": "Order",
            "type": "number",
            "enabled": true,
            "required": false,
            "visible": true
          }
        ]
      }
    }
  ],
  "create": {
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules",
    "rel": [
      "create-form"
    ],
    "method": "POST",
    "value": [
      {
        "name": "name",
        "pattern": {},
        "label": "Name",
        "type": "string",
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "value",
        "label": "Match Value",
        "type": "string",
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "matchType",
        "label": "Match Type",
        "type": "string",
        "options": [
          {
            "label": "Pattern Match",
            "value": "Pattern Match"
          },
          {
            "label": "Exact Match",
            "value": "Exact Match"
          }
        ],
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "routingAction",
        "label": "Routing Destination",
        "type": "string",
        "pattern": {},
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "proxyAction",
        "label": "Proxy Action",
        "type": "string",
        "options": [
          {
            "label": "Redirect",
            "value": "Redirect"
          },
          {
            "label": "Rewrite",
            "value": "Rewrite"
          }
        ],
        "enabled": true,
        "required": true,
        "visible": true
      }
    ]
  }
}

GET Read Domain Rule

Gets the details for a specific rule.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length2133
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 14:09:22 GMT
EtagW/"855-8ocqgfk33zfubaZR0xESbKdu+7A"
ServerEDJX
Traceparent00-bf9227b38058b190b733ef4db51a41f9-d6e3b478f76342ef-01
X-Corelation-Idbf9227b38058b190b733ef4db51a41f9
X-Powered-ByExpress
Sample request
Read Domain Rule
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/rules/:ruleId"
GET /api/domains/:domainId/rules/:ruleId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
  "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0001/rules/100g0000-0a0b-0a0d-bbbb-0000000h0001",
  "id": "100g0000-0a0b-0a0d-bbbb-0000000h0001",
  "name": "{{ruleName}}",
  "value": "https://api.edjx.test",
  "order": 1,
  "matchType": "Pattern Match",
  "proxyAction": "Redirect",
  "routingAction": "{scheme}://{host}/{path}?{query}",
  "organization": {
    "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
  },
  "domain": {
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0001"
  },
  "createdBy": {
    "id": "210g0000-0a0b-0a0d-bbbb-0000000h0001",
    "name": "example name",
    "email": "foo@example.com",
    "photoUrl": null,
    "href": "https://api.edjx.net/api/users/210g0000-0a0b-0a0d-bbbb-0000000h0001"
  },
  "updatedBy": {
    "href": "https://api.edjx.net/api/users/210g0000-0a0b-0a0d-bbbb-0000000h0001"
  },
  "createdAt": "2022-11-28T12:15:16.579Z",
  "updatedAt": "2022-11-28T12:15:16.579Z",
  "delete": {
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0001/rules/100g0000-0a0b-0a0d-bbbb-0000000h0001",
    "method": "DELETE"
  },
  "update": {
    "rel": [
      "edit-form"
    ],
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0001/rules/100g0000-0a0b-0a0d-bbbb-0000000h0001",
    "method": "PUT",
    "value": [
      {
        "name": "name",
        "pattern": {},
        "label": "Name",
        "type": "string",
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "value",
        "label": "Match Value",
        "type": "string",
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "matchType",
        "label": "Match Type",
        "type": "string",
        "options": [
          {
            "label": "Pattern Match",
            "value": "Pattern Match"
          },
          {
            "label": "Exact Match",
            "value": "Exact Match"
          }
        ],
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "proxyAction",
        "label": "Proxy Action",
        "type": "string",
        "options": [
          {
            "label": "Redirect",
            "value": "Redirect"
          },
          {
            "label": "Rewrite",
            "value": "Rewrite"
          }
        ],
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "routingAction",
        "label": "Routing Destination",
        "type": "string",
        "pattern": {},
        "enabled": true,
        "required": true,
        "visible": true
      },
      {
        "name": "order",
        "label": "Order",
        "type": "number",
        "enabled": true,
        "required": false,
        "visible": true
      }
    ]
  }
}

PUT Update Domain Rule

Updates a specific rule.

Body Params

Body Params Description Type Required Format
name Sets the name of the rule string Yes
matchType Sets the routing match type string Yes Exact Match or Pattern Match
routingAction string Yes
proxyAction Sets the routing action value to redirect or rewrite Yes Redirect or Rewrite
value Sets the routing match type
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length2015
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 14:10:49 GMT
EtagW/"7df-AIvhzo0T9lqg1x0hqR21/1wNL+o"
ServerEDJX
Traceparent00-bead60202636dc75631e682b01c86ec8-e451cdcaf59d157a-01
X-Corelation-Idbead60202636dc75631e682b01c86ec8
X-Powered-ByExpress
Sample request
Update Domain Rule
curl -X PUT -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
    "name": "updated rule name",
    "matchType": "Pattern Match",
    "value": "https://api.edjx.test",
    "proxyAction": "Redirect",
    "routingAction": "{scheme}://{host}/{path}?{query}"
}' "https://api.edjx.net/api/domains/:domainId/rules/:ruleId"
PUT /api/domains/:domainId/rules/:ruleId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
    "name": "updated rule name",
    "matchType": "Pattern Match",
    "value": "https://api.edjx.test",
    "proxyAction": "Redirect",
    "routingAction": "{scheme}://{host}/{path}?{query}"
}
{
    "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules/030g0000-0a0b-0a0d-bbbb-0000000h0000",
    "id": "030g0000-0a0b-0a0d-bbbb-0000000h0000",
    "name": "updated rule name",
    "value": "https://api.edjx.test",
    "order": 1,
    "matchType": "Pattern Match",
    "proxyAction": "Redirect",
    "routingAction": "{scheme}://{host}/{path}?{query}",
    "organization": {
        "href": "https://api.edjx.net/api/organizations/374c1c04-5748-40cb-989a-ca1a389de33f"
    },
    "domain": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "createdBy": {
        "href": "https://api.edjx.net/api/users/d30g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "updatedBy": {
        "href": "https://api.edjx.net/api/users/d30g0000-0a0b-0a0d-bbbb-0000000h0000"
    },
    "createdAt": "2022-11-09T14:09:10.979Z",
    "updatedAt": "2022-11-09T14:10:49.021Z",
    "delete": {
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules/030g0000-0a0b-0a0d-bbbb-0000000h0000",
        "method": "DELETE"
    },
    "update": {
        "rel": [
            "edit-form"
        ],
        "href": "https://api.edjx.net/api/domains/000g0000-0a0b-0a0d-bbbb-0000000h0000/rules/030g0000-0a0b-0a0d-bbbb-0000000h0000",
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "pattern": {},
                "label": "Name",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "value",
                "label": "Match Value",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "matchType",
                "label": "Match Type",
                "type": "string",
                "options": [
                    {
                        "label": "Pattern Match",
                        "value": "Pattern Match"
                    },
                    {
                        "label": "Exact Match",
                        "value": "Exact Match"
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "proxyAction",
                "label": "Proxy Action",
                "type": "string",
                "options": [
                    {
                        "label": "Redirect",
                        "value": "Redirect"
                    },
                    {
                        "label": "Rewrite",
                        "value": "Rewrite"
                    }
                ],
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "routingAction",
                "label": "Routing Destination",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "order",
                "label": "Order",
                "type": "number",
                "enabled": true,
                "required": false,
                "visible": true
            }
        ]
    }
}

DELETE Delete Domain Rule

Deletes a rule from a domain.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length39
Content-Typeapplication/json; charset=utf-8
DateWed, 09 Nov 2022 14:11:10 GMT
EtagW/"27-z3+ty4nKFtn8VwglituFc/cd2fM"
ServerEDJX
Traceparent00-487de38f528381c5200fc9d7e2171889-9283ed4484358200-01
X-Corelation-Id487de38f528381c5200fc9d7e2171889
X-Powered-ByExpress
Sample request
Delete Domain Rule
curl -X DELETE -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/rules/:ruleId"
DELETE /api/domains/:domainId/rules/:ruleId HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "message": "Rule Deleted successfully"
}

Certificates


Upload your valid SSL certificates to the EDJX Platform and self-manage their expiration and renewal.

POST Create Domain Certificate

Adds a certificate-private key pair to enable TLS for a provided domain.

Body Params

Body Params Description Type Required Format
name Sets the name of the certificate string Yes Minimum 2 characters are required and a maximum of 128 characters are allowed, which includes only alphanumeric, hyphen, or underscore
private-key A valid X.509 Certificate. You can copy and paste the content from the certificate .pem file. string Yes
certificate Contains the secret key of the certificate, which is used by the Web server when it makes an SSL/TLS connection string Yes
chain Intermediate certificates up to the root certificate string Yes
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length8061
Content-Typeapplication/json; charset=utf-8
DateSat, 19 Nov 2022 17:13:23 GMT
EtagW/"1f7d-N7EIbDDBJbzyjRjghiHyzB1o9lQ"
ServerEDJX
Traceparent00-94209c2447c7b20286648261209ca0c1-d7d97712d26aacde-01
X-Corelation-Id94209c2447c7b20286648261209ca0c1
X-Powered-ByExpress
Sample request
Create Domain Certificate
curl -X POST -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
        "name": "certificate name",
        "certificate": "{{certificate}}",
        "privateKey": "{{privatekey}}",
        "chain": "{{chain}}"
    }' "https://api.edjx.net/api/domains/:domainId/customCertificate"
POST /api/domains/:domainId/customCertificate HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
        "name": "certificate name",
        "certificate": "{{certificate}}",
        "privateKey": "{{privatekey}}",
        "chain": "{{chain}}"
    }
{
    "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-3b0q-bbbb-100000ph060e/certificates/e00r0000-6z0b-2b0q-bbbb-500000ph060e",
    "id": "e00r0000-8z0b-9b0q-bbbb-100000ph060e",
    "name": "certificate name",
    "type": "custom",
    "certificate": "<-----BEGIN CERTIFICATE----------END CERTIFICATE----->",
    "chain": "<-----BEGIN CERTIFICATE----------END CERTIFICATE----->",
    "expiry": "2023-02-17T23:59:59.000Z",
    "subject": "CN=doc-cname.qateam.in",
    "fingerPrint": "",
    "status": [
        "active"
    ],
    "verificationErrors": null,
    "createdBy": {
        "href": "https://api.edjx.net/api/users/e00r0000-6z0b-9b0q-bbbb-600000ph060e"
    },
    "updatedBy": {
        "href": "https://api.edjx.net/api/users/e00r0000-6z0b-7b0q-bbbb-800000ph060e"
    },
    "createdAt": "2022-11-19T17:13:23.009Z",
    "updatedAt": "2022-11-19T17:13:23.009Z",
    "update": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-4b0q-bbbb-400000ph060e/certificates/y00r0000-8z0b-1b0q-bbbb-700000ph060e",
        "rel": [
            "update-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "pattern": {},
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "certificate",
                "label": "Certificate",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            },
            {
                "name": "chain",
                "label": "Chain",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-2b0q-bbbb-300000ph060e/certificates/e00r0000-6z0b-1b0q-bbbb-100000ph060e",
        "method": "DELETE"
    },
    "privateKey": "<-----BEGIN RSA PRIVATE KEY----------END RSA PRIVATE KEY----->",
    "domain": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-6b0q-bbbb-700000ph060e"
    }
}

GET Read All Domain Certificates

Displays all SSL certificates configured for a domain.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length1379
Content-Typeapplication/json; charset=utf-8
DateFri, 11 Nov 2022 09:40:30 GMT
EtagW/"563-IQkQNqFuzPapZiuOkbMW41MZODg"
ServerEDJX
Traceparent00-1ed8a75b9ac50b27b12c15442cf9c5ba-b919b45a7e54d342-01
X-Corelation-Id1ed8a75b9ac50b27b12c15442cf9c5ba
X-Powered-ByExpress
Sample request
Read All Domain Certificates
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/certificates"
GET /api/domains/:domainId/certificates HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-7b0q-bbbb-300000ph060e/certificates",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 0,
    "first": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-8b0q-bbbb-900000ph060e/certificates?page=1",
        "rel": [
            "collection"
        ]
    },
    "next": null,
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-1b0q-bbbb-100000uh090e/certificates?page=1",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "total": 0
    },
    "value": [],
    "upload": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-1b0q-bbbb-900000ph050e/customCertificate",
        "rel": [
            "update-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "type": "string",
                "pattern": {},
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "certificate",
                "label": "Certificate",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "chain",
                "label": "Chain",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "privateKey",
                "label": "Private Key",
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            }
        ]
    },
    "generate": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-1b0q-bbbb-900000ph050e/managedCertificate",
        "rel": [
            "generate-form"
        ],
        "method": "POST",
        "value": [
            {
                "name": "canOverrideAcmeRecord",
                "label": "CanOverrideAcmeRecord",
                "type": "boolean",
                "enabled": true,
                "required": false,
                "visible": true
            }
        ]
    }
}

GET Read Domain Certificate

Displays the details for a specific TLS certificate.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length6408
Content-Typeapplication/json; charset=utf-8
DateSat, 19 Nov 2022 17:14:53 GMT
EtagW/"1908-rYrPhjiVXwG17Z+6DgBnnsW68sQ"
ServerEDJX
Traceparent00-259a4c60bb1cc4e2c08028e8d8b97772-c4a379da95bc65da-01
X-Corelation-Id259a4c60bb1cc4e2c08028e8d8b97772
X-Powered-ByExpress
Sample request
Read Domain Certificate
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/certificates/:certificateId"
GET /api/domains/:domainId/certificates/:certificateId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-7b0t-bbbb-500000ph060t/certificates/e00r0000-6z0b-7b0u-bbbb-400000ph070e",
    "id": "",
    "name": "certificate name",
    "type": "custom",
    "certificate": "<-----BEGIN CERTIFICATE----------END CERTIFICATE----->",
    "chain": "<-----BEGIN CERTIFICATE----------END CERTIFICATE----->",
    "expiry": "2023-02-17T23:59:59.000Z",
    "subject": "CN=doc-cname.qateam.in",
    "fingerPrint": "",
    "status": [
        "active"
    ],
    "verificationErrors": null,
    "createdBy": {
        "id": "e00r0000-7z0b-8b0q-bbbb-100000ph060e",
        "name": "Automation Test",
        "email": "testedjx@mailinator.com",
        "photoUrl": null,
        "href": "https://api.edjx.net/api/users/e00r0000-6z0b-7b0q-btbb-300000ph090e"
    },
    "updatedBy": {
        "href": "https://api.edjx.net/api/users/e00r0000-6z0b-7b0q-bbbb-300000ph060e"
    },
    "createdAt": "2022-11-19T17:13:23.009Z",
    "updatedAt": "2022-11-19T17:13:23.009Z",
    "update": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-8b0q-tbbb-300000ph960e/certificates/e00r0000-6z0b-7b0q-bbbb-300000ph060e",
        "rel": [
            "update-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "pattern": {},
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "certificate",
                "label": "Certificate",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            },
            {
                "name": "chain",
                "label": "Chain",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/domains/e00r0000-6z0b-3b0q-obbb-670000ph060e/certificates/e00r0000-3z0b-9b0q-bbbb-600000ph060e",
        "method": "DELETE"
    },
    "domain": {
        "href": "https://api.edjx.net/api/domains/e00r0000-8z0b-7u0q-bybb-800000ph060t"
    }
}

PUT Update Domain Certificate

Updates the details of a certificate.

Body Params

Body Params Description Type Required Format
name New name of the certificate string No Minimum 2 characters are required and a maximum of 128 characters are allowed, which includes only alphanumeric, hyphen, or underscore
Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status201
Access-Control-Allow-Origin*
Content-Length5851
Content-Typeapplication/json; charset=utf-8
DateFri, 11 Nov 2022 10:54:35 GMT
EtagW/"16db-KDJG8Widq+E8sJNl8C2PaBVaUjc"
ServerEDJX
Traceparent00-ceaf4e171fec04eb94421c8126441aac-d2e79376d94e9de1-01
X-Corelation-Idceaf4e171fec04eb94421c8126441aac
X-Powered-ByExpress
Sample request
Update Domain Certificate
curl -X PUT -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d '{
    "name": "updated certificate name"
}' "https://api.edjx.net/api/domains/:domainId/certificates/:certificateId"
PUT /api/domains/:domainId/certificates/:certificateId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json

{
    "name": "updated certificate name"
}
{
    "href": "https://api.edjx.net/api/domains/e00r0000-8z0b-7u0q-bybb-800000ph060t/certificates/e00r0000-8z0b-7u0q-bybb-800000ph060t",
    "id": "",
    "name": "updated certificate name",
    "type": "managed",
    "certificate": "<-----BEGIN CERTIFICATE----------END CERTIFICATE----->",
    "chain": "<-----BEGIN CERTIFICATE----------END CERTIFICATE----->",
    "expiry": "2022-12-15T04:24:30.000Z",
    "subject": "CN=*.datacreationload.qodeblocks.com",
    "fingerPrint": "",
    "status": [
        "active"
    ],
    "verificationErrors": null,
    "createdBy": {
        "href": "https://api.edjx.net/api/users/e00r0000-8z0b-8u0q-bybb-800000ph068t"
    },
    "updatedBy": {
        "href": "https://api.edjx.net/api/users/e00r0000-8z0b-7u0q-bybb-600000ph080y"
    },
    "createdAt": "2022-09-16T05:12:51.492Z",
    "updatedAt": "2022-11-11T10:54:35.529Z",
    "update": {
        "href": "https://api.edjx.net/api/domains/e00r0000-8z0b-9u0q-uybb-400000ph065t/certificates/e00r0000-8z0b-9u0q-bibb-900000ph0609",
        "rel": [
            "update-form"
        ],
        "method": "PUT",
        "value": [
            {
                "name": "name",
                "label": "Name",
                "pattern": {},
                "type": "string",
                "enabled": true,
                "required": true,
                "visible": true
            },
            {
                "name": "certificate",
                "label": "Certificate",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            },
            {
                "name": "chain",
                "label": "Chain",
                "type": "string",
                "enabled": false,
                "required": true,
                "visible": true
            }
        ]
    },
    "delete": {
        "href": "https://api.edjx.net/api/domains/e00r0000-8z0b-7u0q-bybb-600000ph070u/certificates/e00r0000-8z0b-9u0q-bybb-800000ph760o",
        "method": "DELETE"
    },
    "domain": {
        "href": "https://api.edjx.net/api/domains/e00r0000-9z0b-7u0q-byby-900000ph060o"
    }
}

DELETE Delete Domain Certificate

Deletes the TLS certificate from a specific domain.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length46
Content-Typeapplication/json; charset=utf-8
DateSun, 13 Nov 2022 17:28:46 GMT
EtagW/"2e-afeWICLzQTFVvhT+g0k1qJRdbJI"
ServerEDJX
Traceparent00-191e94c1e48321a722cc8a4c2efa0a74-adacdffc9a1568b6-01
X-Corelation-Id191e94c1e48321a722cc8a4c2efa0a74
X-Powered-ByExpress
Sample request
Delete Domain Certificate
curl -X DELETE -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/domains/:domainId/certificates/:certificateId"
DELETE /api/domains/:domainId/certificates/:certificateId HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "message": "Certificate Deleted successfully"
}

Requests


Tracks the total number of requests received for each serverless function in an organization.

GET Get Function Requests

Gets all requests associated with the function.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Status200
Access-Control-Allow-Origin*
Content-Length12776
Content-Typeapplication/json; charset=utf-8
DateTue, 15 Nov 2022 17:25:28 GMT
EtagW/"31e8-oPj2wqU4YaDLpmyQBQ3bxX8Zdo0"
ServerEDJX
Traceparent00-c125c1a30363a0f13b30e6f687b3199e-94d7feae107968e8-01
X-Corelation-Idc125c1a30363a0f13b30e6f687b3199e
X-Powered-ByExpress
Sample request
Get Function Requests
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" "https://api.edjx.net/api/applications/:applicationId/requests?functionid={{FUNCTION_ID}}&duration=year,2022-01-01,2022-12-31"
GET /api/applications/:applicationId/requests?functionid={{FUNCTION_ID}}&duration=year,2022-01-01,2022-12-31 HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
{
    "self": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests?functionid=100g0000-0a0b-0a0d-bbbb-0000000h040g&duration=year,2022-01-01,2022-12-31",
        "rel": [
            "collection"
        ]
    },
    "offset": 0,
    "limit": 10,
    "size": 730445,
    "first": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests?functionid=100g0000-0a0b-0a0d-bbbb-0000000h040g&duration=year,2022-01-01,2022-12-31&page=1",
        "rel": [
            "collection"
        ]
    },
    "next": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests?functionid=100g0000-0a0b-0a0d-bbbb-0000000h040g&duration=year,2022-01-01,2022-12-31&page=2",
        "rel": [
            "collection"
        ]
    },
    "previous": null,
    "last": {
        "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/requests?functionid=100g0000-0a0b-0a0d-bbbb-0000000h040g&duration=year,2022-01-01,2022-12-31&page=73045",
        "rel": [
            "collection"
        ]
    },
    "summary": {
        "total": 730445,
        "running": 0,
        "completed": 730445,
        "failed": 0,
        "terminated": 0
    },
    "value": [
        {
            "href": "https://api.edjx.net/api/requests/200g0000-0a0b-0a0d-bbbb-0000000h040t",
            "id": "200g0000-0a0b-0a0d-bbbb-0000000h040t",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0010192500000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.418Z",
            "endTime": "2022-11-11T11:44:38.427Z",
            "executionMilliseconds": 8.154,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=200g0000-0a0b-0a0d-bbbb-0000000h040t",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.183Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/200g0000-0a0b-0a0d-bbbb-0000000h040t",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/100t0000-4a0b-0a0d-bbbb-0000000h040t",
            "id": "100t0000-4a0b-0a0d-bbbb-0000000h040t",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0004803750000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.428Z",
            "endTime": "2022-11-11T11:44:38.432Z",
            "executionMilliseconds": 3.843,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=100t0000-4a0b-0a0d-bbbb-0000000h040t",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.183Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/100t0000-4a0b-0a0d-bbbb-0000000h040t",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/300t0000-ea0b-0a0d-bbbb-000000ph040t",
            "id": "300t0000-ea0b-0a0d-bbbb-000000ph040t",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0006457500000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.406Z",
            "endTime": "2022-11-11T11:44:38.411Z",
            "executionMilliseconds": 5.166,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=300t0000-ea0b-0a0d-bbbb-000000ph040t",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.183Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/300t0000-ea0b-0a0d-bbbb-000000ph040t",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/000r0000-3a0b-0a0d-bbbb-000000ph0403",
            "id": "000r0000-3a0b-0a0d-bbbb-000000ph0403",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0012208750000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.441Z",
            "endTime": "2022-11-11T11:44:38.450Z",
            "executionMilliseconds": 9.767,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=000r0000-3a0b-0a0d-bbbb-000000ph0403",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.183Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/000r0000-3a0b-0a0d-bbbb-000000ph0403",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/103r0000-3a0b-0a0d-bbbb-000000ph0403",
            "id": "103r0000-3a0b-0a0d-bbbb-000000ph0403",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0010910000000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.424Z",
            "endTime": "2022-11-11T11:44:38.432Z",
            "executionMilliseconds": 8.728,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=103r0000-3a0b-0a0d-bbbb-000000ph0403",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.183Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/103r0000-3a0b-0a0d-bbbb-000000ph0403",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/100r0000-6a0b-0a0q-bbbb-000000ph0403",
            "id": "100r0000-6a0b-0a0q-bbbb-000000ph0403",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0003975000000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.466Z",
            "endTime": "2022-11-11T11:44:38.469Z",
            "executionMilliseconds": 3.18,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=100r0000-6a0b-0a0q-bbbb-000000ph0403",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.180Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/100r0000-6a0b-0a0q-bbbb-000000ph0403",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/900r0000-6a0b-0a0q-bbbb-100000ph0404",
            "id": "900r0000-6a0b-0a0q-bbbb-100000ph0404",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0009076250000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.451Z",
            "endTime": "2022-11-11T11:44:38.459Z",
            "executionMilliseconds": 7.261,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=900r0000-6a0b-0a0q-bbbb-100000ph0404",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.180Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/900r0000-6a0b-0a0q-bbbb-100000ph0404",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/300r0000-6a0b-0b0q-bbbb-100000ph0408",
            "id": "300r0000-6a0b-0b0q-bbbb-100000ph0408",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0011186250000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.450Z",
            "endTime": "2022-11-11T11:44:38.459Z",
            "executionMilliseconds": 8.949,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=300r0000-6a0b-0b0q-bbbb-100000ph0408",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.180Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/300r0000-6a0b-0b0q-bbbb-100000ph0408",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/500r0000-6z0b-1b0q-bbbb-100000ph0607",
            "id": "500r0000-6z0b-1b0q-bbbb-100000ph0607",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0008202500000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.449Z",
            "endTime": "2022-11-11T11:44:38.455Z",
            "executionMilliseconds": 6.562,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=500r0000-6z0b-1b0q-bbbb-100000ph0607",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.180Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/500r0000-6z0b-1b0q-bbbb-100000ph0607",
                "method": "DELETE"
            }
        },
        {
            "href": "https://api.edjx.net/api/requests/e00r0000-6z0b-1b0q-bbbb-100000ph060e",
            "id": "e00r0000-6z0b-1b0q-bbbb-100000ph060e",
            "status": "completed",
            "memoryBytes": "134217728",
            "networkBytes": "188",
            "computeGB": "0.0009690000000000000000000000000000000000",
            "startTime": "2022-11-11T11:44:38.461Z",
            "endTime": "2022-11-11T11:44:38.469Z",
            "executionMilliseconds": 7.752,
            "logs": {
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000/logs?requestId=e00r0000-6z0b-1b0q-bbbb-100000ph060e",
                "rel": [
                    "collection"
                ]
            },
            "application": {
                "id": "000g0000-0a0b-0a0d-bbbb-0000000h0000",
                "href": "https://api.edjx.net/api/applications/000g0000-0a0b-0a0d-bbbb-0000000h0000"
            },
            "function": {
                "trigger": "http",
                "id": "100g0000-0a0b-0a0d-bbbb-0000000h040g",
                "href": "https://api.edjx.net/api/functions/100g0000-0a0b-0a0d-bbbb-0000000h040g"
            },
            "node": {
                "id": "Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd",
                "href": "https://api.edjx.net/api/nodes/Qmf4Y6VmHi46M4GKUavEdWXLd71JWuRK1M3a4m5awJGTBd"
            },
            "createdAt": "2022-11-11T11:44:39.180Z",
            "delete": {
                "href": "https://api.edjx.net/api/requests/e00r0000-6z0b-1b0q-bbbb-100000ph060e",
                "method": "DELETE"
            }
        }
    ]
}

Stats


Statistics are metric data aggregations over a specified time duration. It is available for resources such as applications, functions, and buckets.

GET Compute Stats

Gets the amount of computing used by the applications in GB-Sec.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length818
Content-Typeapplication/json; charset=utf-8
DateWed, 16 Nov 2022 10:52:44 GMT
EtagW/"332-dhRP7tipcrP8Qt3gi75ba3G20nk"
ServerEDJX
Traceparent00-43cbb6cf47204a7075db5079cdac161c-4c451bff3ff30d16-01
X-Corelation-Id43cbb6cf47204a7075db5079cdac161c
X-Powered-ByExpress
Sample request
Compute Stats
curl -X GET -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/stats?resource={{application}}&type=computeGB&duration=year,2022-01-01,2022-12-31"
GET /api/stats?resource={{application}}&type=computeGB&duration=year,2022-01-01,2022-12-31 HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/stats?resource=application&type=computeGB&duration=year,2022-01-01,2022-12-31",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "stats": 0.9723749999999888,
            "time": "2022-01-01T00:00:00Z"
        },
        {
            "stats": 0.059000000000000004,
            "time": "2022-02-01T00:00:00Z"
        },
        {
            "stats": 0.272,
            "time": "2022-03-01T00:00:00Z"
        },
        {
            "stats": 0.05515624999999999,
            "time": "2022-04-01T00:00:00Z"
        },
        {
            "stats": 0.0175,
            "time": "2022-05-01T00:00:00Z"
        },
        {
            "stats": 2.011640625,
            "time": "2022-06-01T00:00:00Z"
        },
        {
            "stats": 523.7665781249997,
            "time": "2022-07-01T00:00:00Z"
        },
        {
            "stats": 1.6175312500000003,
            "time": "2022-08-01T00:00:00Z"
        },
        {
            "stats": 19.594859375000137,
            "time": "2022-09-01T00:00:00Z"
        },
        {
            "stats": 0.9569180156249889,
            "time": "2022-10-01T00:00:00Z"
        },
        {
            "stats": 5143.041033156246,
            "time": "2022-11-01T00:00:00Z"
        }
    ],
    "summary": {
        "total": 5692.364591796871
    }
}

GET Storage Stats

Gets the amount of storage used by the organization(s) as a percentage of usage.

AuthorizationBearer TOKEN
Acceptapplication/ion+json
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length739
Content-Typeapplication/json; charset=utf-8
DateWed, 16 Nov 2022 10:52:56 GMT
EtagW/"2e3-CLmVb2FVjHkPFLv1cqKEbwztTYM"
ServerEDJX
Traceparent00-c9f87f1439639b2b10da4ce18a532425-a5c9ccffc6f870ab-01
X-Corelation-Idc9f87f1439639b2b10da4ce18a532425
X-Powered-ByExpress
Sample request
Storage Stats
curl -X GET -H "Authorization: Bearer TOKEN" -H "Accept: application/ion+json" -H "Content-Type: application/json" "https://api.edjx.net/api/stats?resource={{bucket}}&type=storages&duration=year,2022-01-01,2022-12-31"
GET /api/stats?resource={{bucket}}&type=storages&duration=year,2022-01-01,2022-12-31 HTTP/1.1
Host: api.edjx.net
Authorization: Bearer TOKEN
Accept: application/ion+json
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/stats?resource=bucket&type=storages&duration=year,2022-01-01,2022-12-31",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "stats": 2582975444,
            "time": "2022-01-01T00:00:00Z"
        },
        {
            "stats": 225233357,
            "time": "2022-02-01T00:00:00Z"
        },
        {
            "stats": 15310597594,
            "time": "2022-03-01T00:00:00Z"
        },
        {
            "stats": 93762545,
            "time": "2022-04-01T00:00:00Z"
        },
        {
            "stats": 54344497,
            "time": "2022-05-01T00:00:00Z"
        },
        {
            "stats": 246436541,
            "time": "2022-06-01T00:00:00Z"
        },
        {
            "stats": 206936731,
            "time": "2022-07-01T00:00:00Z"
        },
        {
            "stats": 10852977,
            "time": "2022-08-01T00:00:00Z"
        },
        {
            "stats": 125038718,
            "time": "2022-09-01T00:00:00Z"
        },
        {
            "stats": 700073907,
            "time": "2022-10-01T00:00:00Z"
        },
        {
            "stats": 6872140489,
            "time": "2022-11-01T00:00:00Z"
        }
    ],
    "summary": {
        "total": 26428392800
    }
}

GET Network Stats

Gets the amount of network used by the applications in bytes.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length710
Content-Typeapplication/json; charset=utf-8
DateWed, 16 Nov 2022 10:53:04 GMT
EtagW/"2c6-P1P5+nZyWvnMcp/1UYa5xH85a0Y"
ServerEDJX
Traceparent00-0371ffdddae3f0c118c878bb4071f97f-c5cac888290087ec-01
X-Corelation-Id0371ffdddae3f0c118c878bb4071f97f
X-Powered-ByExpress
Sample request
Network Stats
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/stats?resource={{application}}&type=network&duration=year,2022-01-01,2022-12-31"
GET /api/stats?resource={{application}}&type=network&duration=year,2022-01-01,2022-12-31 HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/stats?resource=application&type=network&duration=year,2022-01-01,2022-12-31",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "stats": 854621,
            "time": "2022-01-01T00:00:00Z"
        },
        {
            "stats": 8103,
            "time": "2022-02-01T00:00:00Z"
        },
        {
            "stats": 129307,
            "time": "2022-03-01T00:00:00Z"
        },
        {
            "stats": 11126,
            "time": "2022-04-01T00:00:00Z"
        },
        {
            "stats": 11080,
            "time": "2022-05-01T00:00:00Z"
        },
        {
            "stats": 3588009,
            "time": "2022-06-01T00:00:00Z"
        },
        {
            "stats": 4772901,
            "time": "2022-07-01T00:00:00Z"
        },
        {
            "stats": 140259,
            "time": "2022-08-01T00:00:00Z"
        },
        {
            "stats": 957791,
            "time": "2022-09-01T00:00:00Z"
        },
        {
            "stats": 20428003,
            "time": "2022-10-01T00:00:00Z"
        },
        {
            "stats": 414253633,
            "time": "2022-11-01T00:00:00Z"
        }
    ],
    "summary": {
        "total": 445154833
    }
}

GET Request Stats

Gets the number of requests made by the applications.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length683
Content-Typeapplication/json; charset=utf-8
DateWed, 16 Nov 2022 10:53:12 GMT
EtagW/"2ab-QxIGzhm06/Dma6YHa5bp4gQyu50"
ServerEDJX
Traceparent00-9269a4e1332f7bce3d3a1a7918fd95cc-30331027b0d4ea65-01
X-Corelation-Id9269a4e1332f7bce3d3a1a7918fd95cc
X-Powered-ByExpress
Sample request
Request Stats
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/stats?resource={{application}}&type=requests&duration=year,2022-01-01,2022-12-31"
GET /api/stats?resource={{application}}&type=requests&duration=year,2022-01-01,2022-12-31 HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/stats?resource=application&type=requests&duration=year,2022-01-01,2022-12-31",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "stats": 20033,
            "time": "2022-01-01T00:00:00Z"
        },
        {
            "stats": 35,
            "time": "2022-02-01T00:00:00Z"
        },
        {
            "stats": 308,
            "time": "2022-03-01T00:00:00Z"
        },
        {
            "stats": 73,
            "time": "2022-04-01T00:00:00Z"
        },
        {
            "stats": 24,
            "time": "2022-05-01T00:00:00Z"
        },
        {
            "stats": 230,
            "time": "2022-06-01T00:00:00Z"
        },
        {
            "stats": 96615,
            "time": "2022-07-01T00:00:00Z"
        },
        {
            "stats": 2599,
            "time": "2022-08-01T00:00:00Z"
        },
        {
            "stats": 16193,
            "time": "2022-09-01T00:00:00Z"
        },
        {
            "stats": 78764,
            "time": "2022-10-01T00:00:00Z"
        },
        {
            "stats": 1670186,
            "time": "2022-11-01T00:00:00Z"
        }
    ],
    "summary": {
        "total": 1885060
    }
}

GET Download Stats

Gets the number of times a file in a bucket is downloaded.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length710
Content-Typeapplication/json; charset=utf-8
DateWed, 16 Nov 2022 10:53:20 GMT
EtagW/"2c6-6kIjHR9Wgg9ioAF/C17s5zlTGrQ"
ServerEDJX
Traceparent00-dcb8b83c6489742864a096eb9000bf4d-445b7390bec73afc-01
X-Corelation-Iddcb8b83c6489742864a096eb9000bf4d
X-Powered-ByExpress
Sample request
Download Stats
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/stats?resource={{bucket}}&type=downloads&bucketld=786d2d05-6668-40cb-989a-cb2b560af22a&duration=year,2022-01-01,2022-12-31"
GET /api/stats?resource={{bucket}}&type=downloads&bucketld=786d2d05-6668-40cb-989a-cb2b560af22a&duration=year,2022-01-01,2022-12-31 HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/stats?resource=bucket&type=downloads&:bucketld=792fb69f-6cf5-4a33-8d84-c47b56e33fa3&duration=year,2022-01-01,2022-12-31",
        "rel": [
            "collection"
        ]
    },
    "value": [
        {
            "stats": 99,
            "time": "2022-01-01T00:00:00Z"
        },
        {
            "stats": 9,
            "time": "2022-02-01T00:00:00Z"
        },
        {
            "stats": 152,
            "time": "2022-03-01T00:00:00Z"
        },
        {
            "stats": 26,
            "time": "2022-04-01T00:00:00Z"
        },
        {
            "stats": 4,
            "time": "2022-05-01T00:00:00Z"
        },
        {
            "stats": 53,
            "time": "2022-06-01T00:00:00Z"
        },
        {
            "stats": 718,
            "time": "2022-07-01T00:00:00Z"
        },
        {
            "stats": 227,
            "time": "2022-08-01T00:00:00Z"
        },
        {
            "stats": 3598,
            "time": "2022-09-01T00:00:00Z"
        },
        {
            "stats": 308,
            "time": "2022-10-01T00:00:00Z"
        },
        {
            "stats": 10189,
            "time": "2022-11-01T00:00:00Z"
        }
    ],
    "summary": {
        "total": 15383
    }
}

Logs


Displays logs generated by all the functions associated with the applications in an organization.

GET Read Application Logs

Displays logs related to a specific application request.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length272855
Content-Typeapplication/json; charset=utf-8
DateWed, 16 Nov 2022 17:38:12 GMT
EtagW/"429d7-nDE4QjJ3QGKx9zIkgquFWX3AWn0"
ServerEDJX
Traceparent00-700200e73b6acd6634b8fa95b23f74b5-84e5c639b4d6efe0-01
X-Corelation-Id700200e73b6acd6634b8fa95b23f74b5
X-Powered-ByExpress
Sample request
Read Application Logs
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/applications/:applicationId/logs?duration=day,2022-10-17T17:35:47.212Z,2022-11-16T17:35:47.213Z&limit={{limit}}"
GET /api/applications/:applicationId/logs?duration=day,2022-10-17T17:35:47.212Z,2022-11-16T17:35:47.213Z&limit={{limit}} HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/applications/e00r0000-6z0b-1b0q-bbbb-100000ph060e/logs?duration=day,2022-10-17T17:35:47.212Z,2022-11-16T17:35:47.213Z&limit=2",
        "rel": [
            "collection"
        ]
    },
    "limit": "2",
    "value": [
        {
            "time": "2022-11-10T12:49:16.000Z",
            "tag": "a00r0000-6z0b-1b0q-bbbb-100000ph0601",
            "record": {
                "functionId": "a03r0000-6z0b-1b0q-bbbb-10e000ph0601",
                "trace_id": "e03r6000-6z1b-1b0q-bbbb-10e000ph0601",
                "functionName": "loadFunc_u1l4I",
                "logText": "Inside example function",
                "trace_flags": "TraceFlags(1)",
                "requestId": "a00r0000-6z0b-1b0q-bbbb-100000ph0601",
                "applicationId": "e00r0000-6z0b-1b0q-bbbb-100000ph060e",
                "logType": "info",
                "span_id": "ba780e569b90d41e",
                "nodeId": "QmYeMuokYGAEZZanKTHrgvmZQ96Wm1CM17zZY1mrV5NNqe",
                "traceID": "e03r6000-6z1b-1b0q-bbbb-10e000ph0601"
            }
        },
        {
            "time": "2022-11-10T12:49:16.000Z",
            "tag": "d03r6000-6z1b-1b0q-bbbb-20e000ph0601",
            "record": {
                "applicationId": "e00r0000-6z0b-1b0q-bbbb-100000ph060e",
                "functionId": "a03r0000-6z0b-1b0q-bbbb-10e000ph0601",
                "functionName": "loadFunc_u1l4I",
                "requestId": "d03r6000-6z1b-1b0q-bbbb-20e000ph0601",
                "logType": "info",
                "trace_id": "86afa6221f31a652b10b6d15727ab45a",
                "nodeId": "QmYeMuokYGAEZZanKTHrgvmZQ96Wm1CM17zZY1mrV5NNqe",
                "logText": "Inside example function",
                "trace_flags": "TraceFlags(1)",
                "span_id": "d467764bd369d5da",
                "traceID": "86afa6221f31a652b10b6d15727ab45a"
            }
        }
    ]
}

GET Read Function Logs

Displays logs related to the functions within a specific application.

Acceptapplication/ion+json
AuthorizationBearer TOKEN
Content-Typeapplication/json
Status200
Access-Control-Allow-Origin*
Content-Length272903
Content-Typeapplication/json; charset=utf-8
DateWed, 16 Nov 2022 17:39:44 GMT
EtagW/"42a07-AAeyBuzZHwdpBZtcTwaJRuwgShc"
ServerEDJX
Traceparent00-575ce448de69443715376333c7b3aab3-ec4a8187b37be6d9-01
X-Corelation-Id575ce448de69443715376333c7b3aab3
X-Powered-ByExpress
Sample request
Read Function Logs
curl -X GET -H "Accept: application/ion+json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" "https://api.edjx.net/api/applications/:applicationId/logs?functionId={{FUNCTIONID}}&duration=day,2022-11-17T17:38:48.498Z,2022-11-25T17:38:48.498Z&limit={{limit}}"
GET /api/applications/:applicationId/logs?functionId={{FUNCTIONID}}&duration=day,2022-11-17T17:38:48.498Z,2022-11-25T17:38:48.498Z&limit={{limit}} HTTP/1.1
Host: api.edjx.net
Accept: application/ion+json
Authorization: Bearer TOKEN
Content-Type: application/json
{
    "self": {
        "href": "https://api.edjx.net/api/applications/a03r6000-6z1b-1b0q-bbbb-10e000ph0601/logs?functionId=203r6000-6z1b-1b0q-4bbb-10e000ph060e&duration=day,2022-10-17T17:38:48.498Z,2022-11-16T17:38:48.498Z&limit=2",
        "rel": [
            "collection"
        ]
    },
    "limit": "2",
    "value": [
        {
            "time": "2022-11-10T12:49:16.000Z",
            "tag": "r03r600f-6z1b-1b0q-4bbd-10e000ph060e",
            "record": {
                "functionId": "203r6000-6z1b-1b0q-4bbb-10e000ph060e",
                "trace_id": "79f9ba6dd3941a81f3ea82d228748c65",
                "functionName": "loadFunc_u1l4I",
                "logText": "Inside example function",
                "trace_flags": "TraceFlags(1)",
                "requestId": "r03r600f-6z1b-1b0q-4bbd-10e000ph060e",
                "applicationId": "a03r6000-6z1b-1b0q-bbbb-10e000ph0601",
                "logType": "info",
                "span_id": "ba780e569b90d41e",
                "nodeId": "QmYeMuokYGAEZZanKTHrgvmZQ96Wm1CM17zZY1mrV5NNqe",
                "traceID": "79f9ba6dd3941a81f3ea82d228748c65"
            }
        },
        {
            "time": "2022-11-10T12:49:16.000Z",
            "tag": "p03r600f-6z1b-1b0q-4bbd-10e000ph060r",
            "record": {
                "applicationId": "a03r6000-6z1b-1b0q-bbbb-10e000ph0601",
                "functionId": "203r6000-6z1b-1b0q-4bbb-10e000ph060e",
                "functionName": "loadFunc_u1l4I",
                "requestId": "p03r600f-6z1b-1b0q-4bbd-10e000ph060r",
                "logType": "info",
                "trace_id": "86afa6221f31a652b10b6d15727ab45a",
                "nodeId": "QmYeMuokYGAEZZanKTHrgvmZQ96Wm1CM17zZY1mrV5NNqe",
                "logText": "Inside example function",
                "trace_flags": "TraceFlags(1)",
                "span_id": "d467764bd369d5da",
                "traceID": "86afa6221f31a652b10b6d15727ab45a"
            }
        }
    ]
}