Administration

Operations related to the administration

Get users

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/users

Get users by admin

Authorizations

bearerAuthaccessToken

Query parameters

usernamestringOptional

The username to search

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

organizationstringOptional

The organization ID to filter

statusstringOptional

The status to filter

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/users

HTTPcURLJavaScriptPython

GET /api/administration/users HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "username": "[email protected]",
      "language": "en",
      "region": "us",
      "firstName": "John",
      "lastName": "Doe",
      "status": 1,
      "attributes": {
        "iamUserId": "1234567890"
      },
      "avatarUrl": "text",
      "settings": {
        "mailOnBuildCompleted": true,
        "mailOnCodePushCompleted": true
      },
      "lastLoginAt": "2020-07-23T12:00:00.000Z",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    },
    {
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "roles": [
        {
          "_id": "63ea10b94a472e003305232b",
          "name": "Presentation",
          "description": "Presentation role",
          "organization": {
            "_id": "63ea10b94a472e003305232b",
            "name": "Akinon",
            "slug": "hello-world",
            "description": "Akinon is a software company",
            "owner": "63ea10b94a472e003305232b",
            "isExecutive": false,
            "status": 1,
            "privileges": [
              "project:read",
              "project:write"
            ],
            "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
            "createdAt": "2020-07-23T12:00:00.000Z",
            "updatedAt": "2020-07-23T12:00:00.000Z"
          },
          "privileges": [
            "project:read",
            "project:write"
          ],
          "createdAt": "2020-07-23T12:00:00.000Z",
          "updatedAt": "2020-07-23T12:00:00.000Z"
        },
        {
          "organization": "63ea10b94a472e003305232b"
        }
      ]
    }
  ]
}

Get a user

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/users/{userId}

Get a user by admin

Authorizations

bearerAuthaccessToken

Path parameters

userIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/users/{userId}

HTTPcURLJavaScriptPython

GET /api/administration/users/{userId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "username": "[email protected]",
  "language": "en",
  "region": "us",
  "firstName": "John",
  "lastName": "Doe",
  "status": 1,
  "attributes": {
    "iamUserId": "1234567890"
  },
  "avatarUrl": "text",
  "settings": {
    "mailOnBuildCompleted": true,
    "mailOnCodePushCompleted": true
  },
  "lastLoginAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "roles": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "Presentation",
      "description": "Presentation role",
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "privileges": [
        "project:read",
        "project:write"
      ],
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    },
    {
      "organization": "63ea10b94a472e003305232b"
    }
  ]
}

Update a user

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/users/{userId}

Update a user by admin

Authorizations

bearerAuthaccessToken

Path parameters

userIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Query parameters

updatedAtstring · date-timeRead-onlyRequired

The date

Example: 2020-07-23T12:00:00.000Z

Body

application/json

firstNamestring · min: 5 · max: 255Optional

The user first name

Example: John

lastNamestring · min: 5 · max: 255Optional

The user last name

Example: Doe

statusinteger · enumOptional

The status

Example: 1Possible values:

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/administration/users/{userId}

HTTPcURLJavaScriptPython

PATCH /api/administration/users/{userId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "firstName": "John",
  "lastName": "Doe",
  "status": 1
}

{
  "_id": "63ea10b94a472e003305232b",
  "username": "[email protected]",
  "language": "en",
  "region": "us",
  "firstName": "John",
  "lastName": "Doe",
  "status": 1,
  "attributes": {
    "iamUserId": "1234567890"
  },
  "avatarUrl": "text",
  "settings": {
    "mailOnBuildCompleted": true,
    "mailOnCodePushCompleted": true
  },
  "lastLoginAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a user public keys

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/users/{userId}/public-keys

Get a user public keys by admin

Authorizations

bearerAuthaccessToken

Path parameters

userIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/users/{userId}/public-keys

HTTPcURLJavaScriptPython

GET /api/administration/users/{userId}/public-keys HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Get roles

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/roles

Get roles by admin

Authorizations

bearerAuthaccessToken

Query parameters

textstringOptional

The text to search

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

privilegesstringOptional

The privileges to filter

organizationstringOptional

The organization ID to filter

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/roles

HTTPcURLJavaScriptPython

GET /api/administration/roles HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "Presentation",
      "description": "Presentation role",
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "privileges": [
        "project:read",
        "project:write"
      ],
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    },
    {
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      }
    }
  ]
}

Get privileges

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/privileges

Get privileges by admin

Authorizations

bearerAuthaccessToken

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/privileges

HTTPcURLJavaScriptPython

GET /api/administration/privileges HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "administration": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "group": "administration"
    }
  ],
  "organization": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "group": "administration"
    }
  ]
}

Get privileges by level

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/privileges/{level}

Get privileges by level by admin

Authorizations

bearerAuthaccessToken

Path parameters

levelstring · enumRequired

The privilege level

Example: organizationPossible values:

Query parameters

limitintegerOptional

The limit of per page

Default: 10

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/privileges/{level}

HTTPcURLJavaScriptPython

GET /api/administration/privileges/{level} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "organization": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "group": "organization"
    }
  ]
}

Get changelogs

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/changelogs

Get changelogs by admin

Authorizations

bearerAuthaccessToken

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/changelogs

HTTPcURLJavaScriptPython

GET /api/administration/changelogs HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "targetVersion": "1.0.0",
      "summary": "This is a summary",
      "markdown": "text",
      "rank": 0,
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a changelog

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/changelogs

Create a changelog by admin

Authorizations

bearerAuthaccessToken

Body

application/json

targetVersionstring · min: 4 · max: 20Required

The target version

Example: 1.0.0

summarystringRequired

The changelog summary

Example: First version

markdownstringRequired

The changelog markdown

Example: # Changelog ## 1.0.0 - First version

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/changelogs

HTTPcURLJavaScriptPython

POST /api/administration/changelogs HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "targetVersion": "1.0.0",
  "summary": "First version",
  "markdown": "# Changelog\n## 1.0.0\n- First version\n"
}

{
  "_id": "63ea10b94a472e003305232b",
  "targetVersion": "1.0.0",
  "summary": "This is a summary",
  "markdown": "text",
  "rank": 0,
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a changelog

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/changelogs/{changelogId}

Get a changelog by admin

Authorizations

bearerAuthaccessToken

Path parameters

changelogIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/changelogs/{changelogId}

HTTPcURLJavaScriptPython

GET /api/administration/changelogs/{changelogId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "targetVersion": "1.0.0",
  "summary": "This is a summary",
  "markdown": "text",
  "rank": 0,
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a changelog

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/changelogs/{changelogId}

Delete a changelog by admin

Authorizations

bearerAuthaccessToken

Path parameters

changelogIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/administration/changelogs/{changelogId}

HTTPcURLJavaScriptPython

DELETE /api/administration/changelogs/{changelogId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a changelog

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/changelogs/{changelogId}

Update changelog by admin user

Authorizations

bearerAuthaccessToken

Path parameters

changelogIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Body

application/json

targetVersionstring · min: 4 · max: 20Required

The target version

Example: 1.0.0

summarystringRequired

The changelog summary

Example: First version

markdownstringRequired

The changelog markdown

Example: # Changelog ## 1.0.0 - First version

updatedAtstring · date-timeRead-onlyRequired

The date

Example: 2020-07-23T12:00:00.000Z

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/administration/changelogs/{changelogId}

HTTPcURLJavaScriptPython

PATCH /api/administration/changelogs/{changelogId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "targetVersion": "1.0.0",
  "summary": "First version",
  "markdown": "# Changelog\n## 1.0.0\n- First version\n"
}

{
  "_id": "63ea10b94a472e003305232b",
  "targetVersion": "1.0.0",
  "summary": "This is a summary",
  "markdown": "text",
  "rank": 0,
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get deployments

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/deployments

Get deployments by admin

Authorizations

bearerAuthaccessToken

Query parameters

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

statusstringOptional

The status to filter

projectstringOptional

The project ID to filter

buildTargetstring · enumOptional

The buildTarget to filter

Possible values:

deploymentTypestring · enumOptional

The deploymentType to filter

Possible values:

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/deployments

HTTPcURLJavaScriptPython

GET /api/administration/deployments HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "project": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Toys Shop",
        "slug": "hello-world",
        "description": "The best toys shop",
        "organization": "6131198510b4640b303ebf1b",
        "credential": {},
        "additionalCredentials": {},
        "appStatuses": {
          "android": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            }
          },
          "huawei": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            }
          },
          "ios": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z"
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z"
            }
          }
        },
        "status": "active",
        "lastActivityAt": "2020-07-23T12:00:00.000Z",
        "appIconUrl": "https://example.com/icon.png",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "user": {
        "_id": "63ea10b94a472e003305232b",
        "username": "[email protected]",
        "language": "en",
        "region": "us",
        "firstName": "John",
        "lastName": "Doe",
        "status": 1,
        "attributes": {
          "iamUserId": "1234567890"
        },
        "avatarUrl": "text",
        "settings": {
          "mailOnBuildCompleted": true,
          "mailOnCodePushCompleted": true
        },
        "lastLoginAt": "2020-07-23T12:00:00.000Z",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "parent": "63ea10b94a472e003305232b",
      "description": "This is a deployment",
      "status": "success",
      "os": "android",
      "buildTarget": "production",
      "deploymentType": "build",
      "stages": [
        {
          "_id": "63ea10b94a472e003305232b",
          "name": "text",
          "createdAt": "2020-07-23T12:00:00.000Z",
          "updatedAt": "2020-07-23T12:00:00.000Z"
        }
      ],
      "startedAt": "2020-07-23T12:00:00.000Z",
      "completedAt": "2020-07-23T12:00:00.000Z",
      "abolisher": "63ea10b94a472e003305232b",
      "forceUpdate": true,
      "tag": "text",
      "checksum": "text",
      "size": 1,
      "uploadDuration": 1,
      "remoteId": 1,
      "plugins": [
        {
          "name": "text",
          "version": "text",
          "moduleName": "text"
        }
      ],
      "issues": [
        {
          "type": "error",
          "message": "text"
        }
      ],
      "timeline": [
        {
          "step": 1,
          "startTime": "2020-07-23T12:00:00.000Z",
          "finishTime": "2020-07-23T12:00:00.000Z",
          "error": "text"
        }
      ],
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z",
      "versionCode": 12,
      "javaVersion": 1.8,
      "xcodeVersion": 12,
      "extensions": [
        "com.akinon.fashfed.RelatedDigitalNotificationExtension",
        "com.akinon.fashfed.RelatedDigitalNotificationContent"
      ],
      "envVersion": "1.0.0",
      "storeVersion": "text",
      "isLive": true,
      "isOnStore": "success"
    }
  ]
}

Get a deployment

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/deployments/{deploymentId}

Get a deployment by admin

Authorizations

bearerAuthaccessToken

Path parameters

deploymentIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

Responseone of

all ofOptional

and

or

all ofOptional

and

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/deployments/{deploymentId}

HTTPcURLJavaScriptPython

GET /api/administration/deployments/{deploymentId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "versionCode": 12,
  "javaVersion": 1.8,
  "xcodeVersion": 12,
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "1.0.0",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": "success"
}

Get projects

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/projects

Get projects by admin

Authorizations

bearerAuthaccessToken

Query parameters

textstringOptional

The text to search

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/projects

HTTPcURLJavaScriptPython

GET /api/administration/projects HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "Toys Shop",
      "slug": "hello-world",
      "description": "The best toys shop",
      "organization": "63ea10b94a472e003305232b",
      "credential": {},
      "additionalCredentials": {},
      "appStatuses": {
        "android": {
          "production": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z",
            "versionCode": 12
          },
          "staging": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z",
            "versionCode": 12
          }
        },
        "huawei": {
          "production": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z",
            "versionCode": 12
          },
          "staging": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z",
            "versionCode": 12
          }
        },
        "ios": {
          "production": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z"
          },
          "staging": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z"
          }
        }
      },
      "status": "active",
      "lastActivityAt": "2020-07-23T12:00:00.000Z",
      "appIconUrl": "https://example.com/icon.png",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Transfer a project

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/projects/{projectId}/transfers

Transfer a project by admin

Authorizations

bearerAuthaccessToken

Path parameters

projectIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Body

application/json

descriptionstring · max: 255Required

The transfer description

Example: Transfer to organization

destinationstringRequired

The destination organization ID

Example: 5f1a0b5b1c9d440000a1a1a1

Responses

201

Created

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/projects/{projectId}/transfers

HTTPcURLJavaScriptPython

POST /api/administration/projects/{projectId}/transfers HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "description": "Transfer to organization",
  "destination": "5f1a0b5b1c9d440000a1a1a1"
}

{
  "project": "63ea10b94a472e003305232b",
  "source": "63ea10b94a472e003305232b",
  "destination": "63ea10b94a472e003305232b",
  "description": "Transfer to organization",
  "user": "63ea10b94a472e003305232b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get events

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/tracker/events

Get events by admin

Authorizations

bearerAuthaccessToken

Query parameters

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

fromDatestringOptional

filter events from this date

Responses

200

OK

application/json

Responseall of

and

get

/administration/services/tracker/events

HTTPcURLJavaScriptPython

GET /api/administration/services/tracker/events HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "user": {
        "_id": "63ea10b94a472e003305232b",
        "firstName": "John",
        "lastName": "Doe",
        "username": "text"
      },
      "action": {
        "method": "GET",
        "url": "/api/users"
      },
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Get notifications

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/notifications

Get notifications by admin

Authorizations

bearerAuthaccessToken

Query parameters

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/notifications

HTTPcURLJavaScriptPython

GET /api/administration/notifications HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "title": "text",
      "description": "text",
      "user": "63ea10b94a472e003305232b",
      "publishAt": "2020-07-23T12:00:00.000Z",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z",
      "isVisible": true
    },
    {
      "user": {
        "_id": "63ea10b94a472e003305232b",
        "username": "[email protected]",
        "language": "en",
        "region": "us",
        "firstName": "John",
        "lastName": "Doe",
        "status": 1,
        "attributes": {
          "iamUserId": "1234567890"
        },
        "avatarUrl": "text",
        "settings": {
          "mailOnBuildCompleted": true,
          "mailOnCodePushCompleted": true
        },
        "lastLoginAt": "2020-07-23T12:00:00.000Z",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      }
    }
  ]
}

Create a notification

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/notifications

Create a notification by admin

Authorizations

bearerAuthaccessToken

Body

application/json

titlestring · min: 3 · max: 255Required

The notification title

Example: New notification

descriptionstring · max: 1000Required

The notification description

Example: This is a new notification

publishAtstring · date-timeRequired

The date

Example: 2024-07-23T12:00:00.000Z

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/notifications

HTTPcURLJavaScriptPython

POST /api/administration/notifications HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "title": "New notification",
  "description": "This is a new notification",
  "publishAt": "2024-07-23T12:00:00.000Z"
}

{
  "_id": "63ea10b94a472e003305232b",
  "title": "text",
  "description": "text",
  "user": "63ea10b94a472e003305232b",
  "publishAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "isVisible": true
}

Get a notification

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/notifications/{notificationId}

Get a notification by admin

Authorizations

bearerAuthaccessToken

Path parameters

notificationIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/notifications/{notificationId}

HTTPcURLJavaScriptPython

GET /api/administration/notifications/{notificationId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "title": "text",
  "description": "text",
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "publishAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "isVisible": true
}

Update a notification

put

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/notifications/{notificationId}

Update a notification by admin

Authorizations

bearerAuthaccessToken

Path parameters

notificationIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Body

application/json

titlestring · min: 3 · max: 255Optional

The notification title

Example: New notification

descriptionstring · max: 1000Optional

The notification description

Example: This is a new notification

isVisiblebooleanOptional

The notification visible

Example: true

publishAtstring · date-timeOptional

The date

Example: 2024-07-23T12:00:00.000Z

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/administration/notifications/{notificationId}

HTTPcURLJavaScriptPython

PUT /api/administration/notifications/{notificationId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "title": "New notification",
  "description": "This is a new notification",
  "isVisible": true,
  "publishAt": "2024-07-23T12:00:00.000Z"
}

{
  "_id": "63ea10b94a472e003305232b",
  "title": "text",
  "description": "text",
  "user": "63ea10b94a472e003305232b",
  "publishAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "isVisible": true
}

Delete a notification

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/notifications/{notificationId}

Delete a notification by admin

Authorizations

bearerAuthaccessToken

Path parameters

notificationIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/administration/notifications/{notificationId}

HTTPcURLJavaScriptPython

DELETE /api/administration/notifications/{notificationId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get organizations

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/organizations

Get organizations by admin

Authorizations

bearerAuthaccessToken

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

textstringOptional

The text to search

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/organizations

HTTPcURLJavaScriptPython

GET /api/administration/organizations HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "Akinon",
      "slug": "hello-world",
      "description": "Akinon is a software company",
      "owner": "63ea10b94a472e003305232b",
      "isExecutive": false,
      "status": 1,
      "privileges": [
        "project:read",
        "project:write"
      ],
      "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a organization

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/organizations

Create a organization by admin

Authorizations

bearerAuthaccessToken

Body

application/json

namestringRequired

The organization name

Example: Akinon

descriptionstringRequired

The organization description

Example: Akinon description

statusnumberOptional

The organization status

Default: 1Example: 1

ownerall ofRequired

stringOptional

and

anyOptional

The organization owner

and

stringOptional

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

privilegesstring[]Optional

The organization privileges

Example: organization:user:read

imageUrlstringOptional

The organization image url

Example: https://prod-test-statics.s3.eu-central-1.amazonaws.com/projects_statics_v2_giphy.gif

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/organizations

HTTPcURLJavaScriptPython

POST /api/administration/organizations HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "name": "Akinon",
  "description": "Akinon description",
  "status": 1,
  "owner": "63ea10b94a472e003305232b",
  "privileges": [
    "organization:user:read"
  ],
  "imageUrl": "https://prod-test-statics.s3.eu-central-1.amazonaws.com/projects_statics_v2_giphy.gif"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Akinon",
  "slug": "hello-world",
  "description": "Akinon is a software company",
  "owner": "63ea10b94a472e003305232b",
  "isExecutive": false,
  "status": 1,
  "privileges": [
    "project:read",
    "project:write"
  ],
  "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a organization

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/organizations/{organizationId}

Get a organization by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The organization ID

Example: 1234567890abcdef12345678 or my-organization

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/organizations/{organizationId}

HTTPcURLJavaScriptPython

GET /api/administration/organizations/{organizationId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Akinon",
  "slug": "hello-world",
  "description": "Akinon is a software company",
  "owner": "63ea10b94a472e003305232b",
  "isExecutive": false,
  "status": 1,
  "privileges": [
    "project:read",
    "project:write"
  ],
  "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Update a organization

put

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/organizations/{organizationId}

Update a organization by admin

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Body

application/json

namestringRequired

The organization name

Example: Akinon

descriptionstringRequired

The organization description

Example: Akinon description

statusnumberOptional

The organization status

Example: 1

ownerall ofRequired

stringOptional

and

anyOptional

The organization owner

and

stringOptional

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

privilegesstring[]Optional

The organization privileges

Example: organization:user:read

imageUrlstringOptional

The organization image url

Example: https://prod-test-statics.s3.eu-central-1.amazonaws.com/projects_statics_v2_giphy.gif

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/administration/organizations/{organizationId}

HTTPcURLJavaScriptPython

PUT /api/administration/organizations/{organizationId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "name": "Akinon",
  "description": "Akinon description",
  "status": 1,
  "owner": "63ea10b94a472e003305232b",
  "privileges": [
    "organization:user:read"
  ],
  "imageUrl": "https://prod-test-statics.s3.eu-central-1.amazonaws.com/projects_statics_v2_giphy.gif"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Akinon",
  "slug": "hello-world",
  "description": "Akinon is a software company",
  "owner": "63ea10b94a472e003305232b",
  "isExecutive": false,
  "status": 1,
  "privileges": [
    "project:read",
    "project:write"
  ],
  "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get invitations

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/invitations

Get invitations by admin

Authorizations

bearerAuthaccessToken

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

statusstringOptional

The status to filter

organizationstringOptional

The organization ID to filter

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/invitations

HTTPcURLJavaScriptPython

GET /api/administration/invitations HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "email": "[email protected]",
      "token": true,
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "user": "63ea10b94a472e003305232b",
      "registered": {
        "completedAt": "2020-07-23T12:00:00.000Z",
        "user": "63ea10b94a472e003305232b"
      },
      "status": "pending",
      "validatedAt": "2020-07-23T12:00:00.000Z",
      "_id": "63ea10b94a472e003305232b",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a invitation

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/invitations

Create a invitation by admin

Authorizations

bearerAuthaccessToken

Body

application/json

emailstringRequired

The invitation email

Example: [email protected]

validatedAtall ofRequired

stringOptional

and

anyOptional

The invitation validated at date

and

string · date-timeOptional

The date

Example: 2024-07-23T12:00:00.000Z

organizationall ofOptional

stringOptional

and

anyOptional

The invitation organization

and

stringOptional

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/invitations

HTTPcURLJavaScriptPython

POST /api/administration/invitations HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "email": "[email protected]",
  "validatedAt": "2024-07-23T12:00:00.000Z",
  "organization": "63ea10b94a472e003305232b"
}

{
  "email": "[email protected]",
  "token": true,
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": "63ea10b94a472e003305232b",
  "registered": {
    "completedAt": "2020-07-23T12:00:00.000Z",
    "user": "63ea10b94a472e003305232b"
  },
  "status": "pending",
  "validatedAt": "2020-07-23T12:00:00.000Z",
  "_id": "63ea10b94a472e003305232b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Update a invitation

put

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/invitations/{invitationId}

Make suspended the invitation status

Authorizations

bearerAuthaccessToken

Path parameters

invitationIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Body

application/json

objectOptional

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/administration/invitations/{invitationId}

HTTPcURLJavaScriptPython

PUT /api/administration/invitations/{invitationId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "email": "[email protected]",
  "token": true,
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": "63ea10b94a472e003305232b",
  "registered": {
    "completedAt": "2020-07-23T12:00:00.000Z",
    "user": "63ea10b94a472e003305232b"
  },
  "status": "pending",
  "validatedAt": "2020-07-23T12:00:00.000Z",
  "_id": "63ea10b94a472e003305232b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get dependencies

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/dependencies

Get dependencies by admin

Authorizations

bearerAuthaccessToken

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

textstringOptional

The text to search

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

isPrivatebooleanOptional

The is private to filter

organizationstringOptional

The organization ID to filter

Responses

200

OK

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/dependencies

HTTPcURLJavaScriptPython

GET /api/administration/dependencies HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "isPrivate": true,
      "readme": "This is a readme",
      "isVisible": true,
      "_id": "63ea10b94a472e003305232b",
      "name": "akinon-cli",
      "organization": "6131198510b4640b303ebf1b",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a dependency

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/dependencies

Create a dependency by organization user

Authorizations

bearerAuthaccessToken

Body

application/json

namestringRequired

The dependency name

Example: test-plugin

organizationall ofRequired

stringOptional

and

anyOptional

The dependency organization

and

stringOptional

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

isPrivatebooleanOptional

The dependency is private

Example: true

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/dependencies

HTTPcURLJavaScriptPython

POST /api/administration/dependencies HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "name": "test-plugin",
  "organization": "63ea10b94a472e003305232b",
  "isPrivate": true
}

{
  "isPrivate": true,
  "readme": "This is a readme",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "akinon-cli",
  "organization": "6131198510b4640b303ebf1b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a dependency

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/dependencies/{dependencyId}

Get a dependency by admin

Authorizations

bearerAuthaccessToken

Path parameters

dependencyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/dependencies/{dependencyId}

HTTPcURLJavaScriptPython

GET /api/administration/dependencies/{dependencyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "isPrivate": true,
  "readme": "This is a readme",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "akinon-cli",
  "organization": "6131198510b4640b303ebf1b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Update a dependency

put

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/dependencies/{dependencyId}

Update a dependency by organization user

Authorizations

bearerAuthaccessToken

Path parameters

dependencyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Body

application/json

isVisiblebooleanOptional

The dependency is visible

Example: true

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/administration/dependencies/{dependencyId}

HTTPcURLJavaScriptPython

PUT /api/administration/dependencies/{dependencyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "isVisible": true
}

{
  "isPrivate": true,
  "readme": "This is a readme",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "akinon-cli",
  "organization": "6131198510b4640b303ebf1b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get dependency packages

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/dependencies/{dependencyId}/packages

Get dependency packages by admin

Authorizations

bearerAuthaccessToken

Path parameters

dependencyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

versionNumberstringOptional

The version number to filter

envVersionNumberstringOptional

The env version number to filter

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/dependencies/{dependencyId}/packages

HTTPcURLJavaScriptPython

GET /api/administration/dependencies/{dependencyId}/packages HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
      "isPrivate": true,
      "readme": "This is a readme",
      "_id": "63ea10b94a472e003305232b",
      "versionNumber": "1.0.0",
      "publisher": {
        "_id": "63ea10b94a472e003305232b",
        "firstName": "Buğrahan",
        "lastName": "Öztürk"
      },
      "dependency": "63ea10b94a472e003305232b",
      "checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
      "rank": 81001623508.4455,
      "envVersionNumber": "1.0.1",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a dependency package

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/dependencies/{dependencyId}/packages

Create a dependency package by admin

Authorizations

bearerAuthaccessToken

Path parameters

dependencyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Body

application/json

namestringRequired

The dependency package name

Example: test-plugin-1.0.0.tgz

versionNumberstringRequired

The dependency package version number

Example: 1.0.0

envVersionstringRequired

The dependency package env version

Example: 1.0.0

urlstringRequired

The dependency package url

Example: https://mobile-statics.s3.eu-central-1.amazonaws.com/projects_statics/dependencies/test-plugin/test-plugin-1.0.0.tgz

checksumstringRequired

The dependency package checksum

Example: 0a6ccf4046b552a92c6b026b414fe28f

isPrivatebooleanOptional

The dependency package is private

Example: true

readmestringOptional

The dependency package readme

Example: test readme

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/administration/dependencies/{dependencyId}/packages

HTTPcURLJavaScriptPython

POST /api/administration/dependencies/{dependencyId}/packages HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 288

{
  "name": "test-plugin-1.0.0.tgz",
  "versionNumber": "1.0.0",
  "envVersion": "1.0.0",
  "url": "https://mobile-statics.s3.eu-central-1.amazonaws.com/projects_statics/dependencies/test-plugin/test-plugin-1.0.0.tgz",
  "checksum": "0a6ccf4046b552a92c6b026b414fe28f",
  "isPrivate": true,
  "readme": "test readme"
}

{
  "assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
  "isPrivate": true,
  "readme": "This is a readme",
  "_id": "63ea10b94a472e003305232b",
  "versionNumber": "1.0.0",
  "publisher": {
    "_id": "63ea10b94a472e003305232b",
    "firstName": "Buğrahan",
    "lastName": "Öztürk"
  },
  "dependency": "63ea10b94a472e003305232b",
  "checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
  "rank": 81001623508.4455,
  "envVersionNumber": "1.0.1",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a dependency package

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/dependencies/{dependencyId}/packages/{packageId}

Get a dependency package by admin

Authorizations

bearerAuthaccessToken

Path parameters

dependencyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

packageIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/dependencies/{dependencyId}/packages/{packageId}

HTTPcURLJavaScriptPython

GET /api/administration/dependencies/{dependencyId}/packages/{packageId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
  "isPrivate": true,
  "readme": "This is a readme",
  "_id": "63ea10b94a472e003305232b",
  "versionNumber": "1.0.0",
  "publisher": {
    "_id": "63ea10b94a472e003305232b",
    "firstName": "Buğrahan",
    "lastName": "Öztürk"
  },
  "dependency": "63ea10b94a472e003305232b",
  "checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
  "rank": 81001623508.4455,
  "envVersionNumber": "1.0.1",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a signed package url

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/dependencies/{dependencyId}/packages/{packageId}/download

Get a signed package url by admin

Authorizations

bearerAuthaccessToken

Path parameters

dependencyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

packageIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Query parameters

urlstringRequired

The url

fileNamestringOptional

The file name

Responses

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/administration/dependencies/{dependencyId}/packages/{packageId}/download

HTTPcURLJavaScriptPython

GET /api/administration/dependencies/{dependencyId}/packages/{packageId}/download?url=text HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "https://akinon.s3.amazonaws.com/..."
}

Get env vars

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/toolsets/envvars/{service}/{name}

Get env vars from spesific service by admin

Authorizations

bearerAuthaccessToken

Path parameters

servicestring · enumRequired

The service

Possible values:

namestringRequired

The env var name

Example: PORT

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/toolsets/envvars/{service}/{name}

HTTPcURLJavaScriptPython

GET /api/administration/toolsets/envvars/{service}/{name} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": "15002"
}

Get codecommits

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/codecommit

Get codecommits by admin

Authorizations

bearerAuthaccessToken

Query parameters

limitintegerOptional

The limit of per page

Default: 10

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/aws/codecommit

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/codecommit HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "Arn": "arn:aws:codecommit:eu-central-1:579380751733:test1",
    "accountId": 579380751733,
    "cloneUrlHttp": "https://git-codecommit.eu-central-1.amazonaws.com/v1/repos/test1",
    "cloneUrlSsh": "ssh://git-codecommit.eu-central-1.amazonaws.com/v1/repos/test1",
    "creationDate": "2024-01-01T17:34:53.334Z",
    "lastModifiedDate": "2024-01-01T17:34:53.334Z",
    "repositoryDescription": "test",
    "repositoryId": "304bae12-ed06-4cab-8cc4-5082829a3007",
    "repositoryName": "test1"
  }
]

Create a codecommit

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/codecommit

Create a codecommit by admin

Authorizations

bearerAuthaccessToken

Body

application/json

repositoryNamestringRequired

The repository name

Example: appm_test_administrator

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/aws/codecommit

HTTPcURLJavaScriptPython

POST /api/administration/services/aws/codecommit HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "repositoryName": "appm_test_administrator"
}

{
  "Arn": "arn:aws:codecommit:eu-central-1:579380751733:test1",
  "accountId": 579380751733,
  "cloneUrlHttp": "https://git-codecommit.eu-central-1.amazonaws.com/v1/repos/test1",
  "cloneUrlSsh": "ssh://git-codecommit.eu-central-1.amazonaws.com/v1/repos/test1",
  "creationDate": "2024-01-01T17:34:53.334Z",
  "lastModifiedDate": "2024-01-01T17:34:53.334Z",
  "repositoryDescription": "test",
  "repositoryId": "304bae12-ed06-4cab-8cc4-5082829a3007",
  "repositoryName": "test1"
}

Get a codecommit

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/codecommit/{codeCommitRepositoryName}

Get a codecommit by admin

Authorizations

bearerAuthaccessToken

Path parameters

codeCommitRepositoryNamestringRequired

The codecommit repository name

Example: appm_test_administrator

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/services/aws/codecommit/{codeCommitRepositoryName}

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/codecommit/{codeCommitRepositoryName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "Arn": "arn:aws:codecommit:eu-central-1:579380751733:test1",
  "accountId": 579380751733,
  "cloneUrlHttp": "https://git-codecommit.eu-central-1.amazonaws.com/v1/repos/test1",
  "cloneUrlSsh": "ssh://git-codecommit.eu-central-1.amazonaws.com/v1/repos/test1",
  "creationDate": "2024-01-01T17:34:53.334Z",
  "lastModifiedDate": "2024-01-01T17:34:53.334Z",
  "repositoryDescription": "test",
  "repositoryId": "304bae12-ed06-4cab-8cc4-5082829a3007",
  "repositoryName": "test1"
}

Delete a codecommit

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/codecommit/{codeCommitRepositoryName}

Delete a codecommit by admin

Authorizations

bearerAuthaccessToken

Path parameters

codeCommitRepositoryNamestringRequired

The codecommit repository name

Example: appm_test_administrator

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/administration/services/aws/codecommit/{codeCommitRepositoryName}

HTTPcURLJavaScriptPython

DELETE /api/administration/services/aws/codecommit/{codeCommitRepositoryName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get buckets

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/toolsets/bucket

Get buckets by admin

Authorizations

bearerAuthaccessToken

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/toolsets/bucket

HTTPcURLJavaScriptPython

GET /api/administration/toolsets/bucket HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "name": "project-static"
    }
  ]
}

Get a signed url

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/toolsets/bucket/{bucketName}/signed-url

Get a signed url by admin

Authorizations

bearerAuthaccessToken

Path parameters

bucketNamestringRequired

The bucket name

Example: project-static

Body

application/json

urlstringRequired

The url

Example: https://prod-test-statics.s3.eu-central-1.amazonaws.com/projects_statics_v2_giphy.gif

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/toolsets/bucket/{bucketName}/signed-url

HTTPcURLJavaScriptPython

POST /api/administration/toolsets/bucket/{bucketName}/signed-url HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "url": "https://prod-test-statics.s3.eu-central-1.amazonaws.com/projects_statics_v2_giphy.gif"
}

{
  "url": "https://akinon.s3.amazonaws.com/..."
}

Get iam users

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users

Get iam users by admin

Authorizations

bearerAuthaccessToken

Query parameters

limitintegerOptional

The limit of per page

Default: 10

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/aws/iam/users

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/iam/users HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "docs": [
    {
      "Path": "/appm/test/",
      "UserName": "appm_test",
      "UserId": "AIDAYNZOIVV2SLHSASCTR",
      "Arn": "arn:aws:iam::579380751733:user/appm/test/appm_test",
      "CreateDate": "2024-07-23T12:00:00.000Z",
      "Tags": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    }
  ]
}

Create a iam user

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users

Create a iam user by admin

Authorizations

bearerAuthaccessToken

Body

application/json

userNamestringRequired

The user name

Example: appm_test

pathstringOptional

The user path

Example: /appm_test/

tagsstring[]Optional

The user tags

Example: ["appm_test"]

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/aws/iam/users

HTTPcURLJavaScriptPython

POST /api/administration/services/aws/iam/users HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "userName": "appm_test",
  "path": "/appm_test/",
  "tags": [
    "appm_test"
  ]
}

{
  "Path": "/appm/test/",
  "UserName": "appm_test",
  "UserId": "AIDAYNZOIVV2SLHSASCTR",
  "Arn": "arn:aws:iam::579380751733:user/appm/test/appm_test",
  "CreateDate": "2024-07-23T12:00:00.000Z",
  "Tags": [
    {
      "Key": "text",
      "Value": "text"
    }
  ]
}

Get user groups

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}/groups

Get user groups by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

Query parameters

limitintegerOptional

The limit of per page

Default: 10

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/aws/iam/users/{userName}/groups

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/iam/users/{userName}/groups HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "docs": [
    {
      "Path": "/appm/test/",
      "GroupName": "appm_test",
      "GroupId": "AIDAYNZOIVV2SLHSASCTR",
      "Arn": "arn:aws:iam::579380751733:group/appm/test/appm_test",
      "CreateDate": "2024-07-23T12:00:00.000Z"
    }
  ]
}

Add a group to a user group

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}/groups

Add a group to a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

Body

application/json

groupNamestringRequired

The group name

Example: appm_test

Responses

201

Created

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/aws/iam/users/{userName}/groups

HTTPcURLJavaScriptPython

POST /api/administration/services/aws/iam/users/{userName}/groups HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "groupName": "appm_test"
}

No content

Delete a group to a user group

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}/groups

Delete a group to a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/administration/services/aws/iam/users/{userName}/groups

HTTPcURLJavaScriptPython

DELETE /api/administration/services/aws/iam/users/{userName}/groups HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get a iam user

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}

Get a iam user by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/services/aws/iam/users/{userName}

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/iam/users/{userName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "Path": "/appm/test/",
  "UserName": "appm_test",
  "UserId": "AIDAYNZOIVV2SLHSASCTR",
  "Arn": "arn:aws:iam::579380751733:user/appm/test/appm_test",
  "CreateDate": "2024-07-23T12:00:00.000Z",
  "Tags": [
    {
      "Key": "text",
      "Value": "text"
    }
  ]
}

Delete a iam user

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}

Delete a iam user by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/administration/services/aws/iam/users/{userName}

HTTPcURLJavaScriptPython

DELETE /api/administration/services/aws/iam/users/{userName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a iam user

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}

Update a iam user by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

Body

application/json

newUserNamestringOptional

The new user name

Example: appm_test2

newPathstringOptional

The new user path

Example: /appm_test2/

userNamestringRequired

The user name

Example: appm_test

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/administration/services/aws/iam/users/{userName}

HTTPcURLJavaScriptPython

PATCH /api/administration/services/aws/iam/users/{userName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "newUserName": "appm_test2",
  "newPath": "/appm_test2/",
  "userName": "appm_test"
}

{
  "Path": "/appm/test/",
  "UserName": "appm_test",
  "UserId": "AIDAYNZOIVV2SLHSASCTR",
  "Arn": "arn:aws:iam::579380751733:user/appm/test/appm_test",
  "CreateDate": "2024-07-23T12:00:00.000Z",
  "Tags": [
    {
      "Key": "text",
      "Value": "text"
    }
  ]
}

Get user public keys

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}/public-keys

Get user public keys by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

Query parameters

limitintegerOptional

The limit of per page

Default: 10

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/aws/iam/users/{userName}/public-keys

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/iam/users/{userName}/public-keys HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "UserName": "appm_test_000000000000000000000001",
    "SSHPublicKeyId": "APKAYNZOIVV27KBKWHSH",
    "Status": "Active",
    "UploadDate": "2023-07-23T18:46:01.000Z"
  }
]

Add a user public key

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}/public-keys

Add a user public key by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

Body

application/json

labelstring · min: 3 · max: 100Required

The public key label

Example: My public key

publicKeystring · min: 1024 · max: 16384Required

The public key

Example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQ4QXQ...

filePathstringOptional

The public key file path

Responses

201

Created

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/aws/iam/users/{userName}/public-keys

HTTPcURLJavaScriptPython

POST /api/administration/services/aws/iam/users/{userName}/public-keys HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "label": "My public key",
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQ4QXQ...",
  "filePath": "text"
}

No content

Delete a user public key

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}/public-keys/{publicKeyId}

Delete a user public key by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

publicKeyIdstringRequired

The AWS SSH public key ID

Example: APKAYNZOIVV2YJAFVDGN

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/administration/services/aws/iam/users/{userName}/public-keys/{publicKeyId}

HTTPcURLJavaScriptPython

DELETE /api/administration/services/aws/iam/users/{userName}/public-keys/{publicKeyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a iam user public key

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/users/{userName}/public-keys/{publicKeyId}

Update a iam user public key by admin

Authorizations

bearerAuthaccessToken

Path parameters

userNamestringRequired

The user name

Example: appm_test

publicKeyIdstringRequired

The AWS SSH public key ID

Example: APKAYNZOIVV2YJAFVDGN

Body

application/json

statusstring · enumRequired

The public key status

Example: 1Possible values:

Responses

200

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/administration/services/aws/iam/users/{userName}/public-keys/{publicKeyId}

HTTPcURLJavaScriptPython

PATCH /api/administration/services/aws/iam/users/{userName}/public-keys/{publicKeyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "status": 1
}

{
  "_id": "63ea10b94a472e003305232b",
  "label": "My public key",
  "status": 1,
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQ4QXQ...",
  "awsPublicKeyId": "text",
  "filePath": "text",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get iam user groups

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups

Get iam user groups by admin

Authorizations

bearerAuthaccessToken

Query parameters

limitintegerOptional

The limit of per page

Default: 10

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/aws/iam/usergroups

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/iam/usergroups HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "docs": [
    {
      "Path": "/appm/test/",
      "GroupName": "appm_test",
      "GroupId": "AIDAYNZOIVV2SLHSASCTR",
      "Arn": "arn:aws:iam::579380751733:group/appm/test/appm_test",
      "CreateDate": "2024-07-23T12:00:00.000Z"
    }
  ]
}

Get a user group

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}

Get a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/services/aws/iam/usergroups/{groupName}

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/iam/usergroups/{groupName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "Group": {
    "Path": "/appm/test/",
    "GroupName": "appm_test",
    "GroupId": "AIDAYNZOIVV2SLHSASCTR",
    "Arn": "arn:aws:iam::579380751733:group/appm/test/appm_test",
    "CreateDate": "2024-07-23T12:00:00.000Z"
  },
  "Users": [
    {
      "Path": "/appm/test/",
      "UserName": "appm_test",
      "UserId": "AIDAYNZOIVV2SLHSASCTR",
      "Arn": "arn:aws:iam::579380751733:user/appm/test/appm_test",
      "CreateDate": "2024-07-23T12:00:00.000Z",
      "Tags": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    }
  ]
}

Delete a user group

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}

Delete a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/administration/services/aws/iam/usergroups/{groupName}

HTTPcURLJavaScriptPython

DELETE /api/administration/services/aws/iam/usergroups/{groupName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a iam user group

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}

Update a iam user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

Body

application/json

newGroupNamestringOptional

The new group name

Example: appm_test_group2

newPathstringOptional

The new group path

Example: /appm_test_group2/

groupNamestringRequired

The group name

Example: appm_test_group

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/administration/services/aws/iam/usergroups/{groupName}

HTTPcURLJavaScriptPython

PATCH /api/administration/services/aws/iam/usergroups/{groupName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "newGroupName": "appm_test_group2",
  "newPath": "/appm_test_group2/",
  "groupName": "appm_test_group"
}

{
  "Path": "/appm/test/",
  "GroupName": "appm_test",
  "GroupId": "AIDAYNZOIVV2SLHSASCTR",
  "Arn": "arn:aws:iam::579380751733:group/appm/test/appm_test",
  "CreateDate": "2024-07-23T12:00:00.000Z"
}

Add a user to a user group

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}/users

Add a user to a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

Body

application/json

userNamestringRequired

The user name

Example: appm_test

Responses

201

Created

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/aws/iam/usergroups/{groupName}/users

HTTPcURLJavaScriptPython

POST /api/administration/services/aws/iam/usergroups/{groupName}/users HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "userName": "appm_test"
}

No content

Remove a user from a user group

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}/users/{userName}

Remove a user from a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

userNamestringRequired

The user name

Example: appm_test

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/administration/services/aws/iam/usergroups/{groupName}/users/{userName}

HTTPcURLJavaScriptPython

DELETE /api/administration/services/aws/iam/usergroups/{groupName}/users/{userName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get user group policies

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}/policies

Get user group policies by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

Responses

204

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/aws/iam/usergroups/{groupName}/policies

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/iam/usergroups/{groupName}/policies HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "docs": [
    [
      "codecommit-policy",
      "iam-policy"
    ]
  ],
  "limit": 100,
  "hasNextPage": false
}

Add a policy to a user group

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}/policies

Add a policy to a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

Body

application/json

policyNamestringRequired

The policy name

Example: IAMReadAccess

Responses

201

Created

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/aws/iam/usergroups/{groupName}/policies

HTTPcURLJavaScriptPython

POST /api/administration/services/aws/iam/usergroups/{groupName}/policies HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "policyName": "IAMReadAccess",
  "policyDocument": {
    "Version": "2012-10-17",
    "Statement": {
      "Effect": "Allow",
      "Action": [
        "iam:Get*",
        "iam:List*",
        "iam:Generate*"
      ],
      "Resource": "*"
    }
  }
}

No content

Get a policy from a user group

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName}

Get a policy from a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

policyNamestringRequired

The policy name

Example: codecommit-policy

Responses

204

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName}

HTTPcURLJavaScriptPython

GET /api/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "GroupName": "appm_test",
  "PolicyName": "codecommit-policy",
  "Group": {
    "Path": "/appm/test/",
    "GroupName": "appm_test",
    "GroupId": "AIDAYNZOIVV2SLHSASCTR",
    "Arn": "arn:aws:iam::579380751733:group/appm/test/appm_test",
    "CreateDate": "2024-07-23T12:00:00.000Z"
  },
  "PolicyDocument": {}
}

Remove a policy from a user group

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName}

Remove a policy from a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

policyNamestringRequired

The policy name

Example: codecommit-policy

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName}

HTTPcURLJavaScriptPython

DELETE /api/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a policy from a user group

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName}

Update a policy from a user group by admin

Authorizations

bearerAuthaccessToken

Path parameters

groupNamestringRequired

The group name

Example: appm_test_group

policyNamestringRequired

The policy name

Example: codecommit-policy

Body

application/json

Responses

200

Created

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName}

HTTPcURLJavaScriptPython

PATCH /api/administration/services/aws/iam/usergroups/{groupName}/policies/{policyName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "policyDocument": {
    "Version": "2012-10-17",
    "Statement": {
      "Effect": "Allow",
      "Action": [
        "iam:Get*",
        "iam:List*",
        "iam:Generate*"
      ],
      "Resource": "*"
    }
  }
}

No content

Create a codepush cache

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/codepush/cachestores

Create a codepush cache by administrator user

Authorizations

bearerAuthaccessToken

Body

application/json

deploymentNamestringRequired

The deployment name in appcenter

Example: 5f5b9b7b9b7b9b7b9b7b9b7b-production

appVersionstringRequired

The app version

Example: 1.0.0

appNamestringRequired

The app name in appcenter

Example: test-app

Responses

201

Created

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/codepush/cachestores

HTTPcURLJavaScriptPython

POST /api/administration/services/codepush/cachestores HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "deploymentName": "5f5b9b7b9b7b9b7b9b7b9b7b-production",
  "appVersion": "1.0.0",
  "appName": "test-app"
}

No content

Get a codepush cache

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/codepush/cachestores/{cachestoreId}

Get a codepush cache by administrator user

Authorizations

bearerAuthaccessToken

Path parameters

cachestoreIdstringRequired

The cache key

Example: qCnsyzxHuwkR-EgqfT8oXREwDUSqnOjNmvzjt_1-0-0

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/codepush/cachestores/{cachestoreId}

HTTPcURLJavaScriptPython

GET /api/administration/services/codepush/cachestores/{cachestoreId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "update_info": {
    "download_url": "https://mobile-statics.s3.eu-central-1.amazonaws.com/codepush-bundles/aUv_-uZ8gclSaYdbY9ELirQw1wQqM24iPE6_F_1-0-5",
    "is_available": true,
    "is_disabled": true,
    "is_mandatory": true,
    "label": "v1",
    "package_hash": "8d8b470d00d308f7ecceb15caab3ab54beaafcefe20d817753d7f62067c74824",
    "package_size": 3318705,
    "should_run_binary_version": true,
    "target_binary_range": "1.0.0",
    "update_app_version": true
  }
}

Delete a codepush cache

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/codepush/cachestores/{cachestoreId}

Delete a codepush cache by administrator user

Authorizations

bearerAuthaccessToken

Path parameters

cachestoreIdstringRequired

The cache key

Example: qCnsyzxHuwkR-EgqfT8oXREwDUSqnOjNmvzjt_1-0-0

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/administration/services/codepush/cachestores/{cachestoreId}

HTTPcURLJavaScriptPython

DELETE /api/administration/services/codepush/cachestores/{cachestoreId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get codepush cdn

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/codepush/cdn

Get codepush cdn by administrator user

Authorizations

bearerAuthaccessToken

Query parameters

projectIdstringOptional

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

envstring · enumRequired

The env

Possible values:

appVersionstringRequired

The app version to filter

Example: 1.0.0

osstring · enumOptional

The os to filter

Possible values:

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/codepush/cdn

HTTPcURLJavaScriptPython

GET /api/administration/services/codepush/cdn?env=staging&appVersion=1.0.0 HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "update_info": {
    "download_url": "https://mobile-statics.s3.eu-central-1.amazonaws.com/codepush-bundles/aUv_-uZ8gclSaYdbY9ELirQw1wQqM24iPE6_F_1-0-5",
    "is_available": true,
    "is_disabled": true,
    "is_mandatory": true,
    "label": "v1",
    "package_hash": "8d8b470d00d308f7ecceb15caab3ab54beaafcefe20d817753d7f62067c74824",
    "package_size": 3318705,
    "should_run_binary_version": true,
    "target_binary_range": "1.0.0",
    "update_app_version": true
  }
}

Delete codepush cdn

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/codepush/cdn

Delete codepush cdn by administrator user

Authorizations

bearerAuthaccessToken

Query parameters

projectIdstringOptional

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

envstring · enumRequired

The env

Possible values:

appVersionstringRequired

The app version to filter

Example: 1.0.0

osstring · enumOptional

The os to filter

Possible values:

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/administration/services/codepush/cdn

HTTPcURLJavaScriptPython

DELETE /api/administration/services/codepush/cdn?env=staging&appVersion=1.0.0 HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get queues names

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues

Get queues names by admin

Authorizations

bearerAuthaccessToken

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/services/queues

HTTPcURLJavaScriptPython

GET /api/administration/services/queues HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "queue-1",
    "isPaused": false
  }
]

Queue pause

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/pause

Queue pause by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

Responses

200

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/services/queues/{name}/pause

HTTPcURLJavaScriptPython

GET /api/administration/services/queues/{name}/pause HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Queue resume

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/resume

Queue resume by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

Responses

200

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/services/queues/{name}/resume

HTTPcURLJavaScriptPython

GET /api/administration/services/queues/{name}/resume HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Queue clean

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/clean

Queue clean by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

Query parameters

typestring · enumOptional

The queue clean type

Default: completedExample: activePossible values:

Responses

200

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/administration/services/queues/{name}/clean

HTTPcURLJavaScriptPython

DELETE /api/administration/services/queues/{name}/clean HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get queue jobs

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/jobs

Get queue jobs by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/services/queues/{name}/jobs

HTTPcURLJavaScriptPython

GET /api/administration/services/queues/{name}/jobs HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Add a job to a queue

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/jobs

Add a job to a queue by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

Body

application/json

namestringRequired

The job name

Example: test-job

dataobjectRequired

The job data

optionsobjectOptional

The job options

Responses

201

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/queues/{name}/jobs

HTTPcURLJavaScriptPython

POST /api/administration/services/queues/{name}/jobs HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "name": "test-job",
  "data": {},
  "options": {}
}

{
  "id": 1234567890,
  "name": "test-job",
  "timestamp": "2024-07-23T12:00:00.000Z",
  "queueQualifiedName": "test-queue",
  "data": {},
  "opts": {},
  "processedOn": 1,
  "finishedOn": 1,
  "failedReason": "text",
  "stacktrace": [
    "text"
  ],
  "attemptsMade": 1,
  "delay": 1,
  "progress": null,
  "returnValue": {},
  "priority": 1,
  "attemptsStarted": 1,
  "stalledCounter": 1
}

Get a queue job

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/jobs/{jobId}

Get a queue job by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

jobIdstringRequired

The job id

Example: 1234567890

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/services/queues/{name}/jobs/{jobId}

HTTPcURLJavaScriptPython

GET /api/administration/services/queues/{name}/jobs/{jobId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1234567890,
  "name": "test-job",
  "timestamp": "2024-07-23T12:00:00.000Z",
  "queueQualifiedName": "test-queue",
  "data": {},
  "opts": {},
  "processedOn": 1,
  "finishedOn": 1,
  "failedReason": "text",
  "stacktrace": [
    "text"
  ],
  "attemptsMade": 1,
  "delay": 1,
  "progress": null,
  "returnValue": {},
  "priority": 1,
  "attemptsStarted": 1,
  "stalledCounter": 1
}

Delete a queue job

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/jobs/{jobId}

Delete a queue job by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

jobIdstringRequired

The job id

Example: 1234567890

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/administration/services/queues/{name}/jobs/{jobId}

HTTPcURLJavaScriptPython

DELETE /api/administration/services/queues/{name}/jobs/{jobId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retry a queue job

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/jobs/{jobId}/retry

Retry a queue job by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

jobIdstringRequired

The job id

Example: 1234567890

Body

application/json

objectOptional

Responses

201

Created

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/administration/services/queues/{name}/jobs/{jobId}/retry

HTTPcURLJavaScriptPython

POST /api/administration/services/queues/{name}/jobs/{jobId}/retry HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{}

Queue job logs

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/services/queues/{name}/jobs/{jobId}/logs

Get queue job logs by admin

Authorizations

bearerAuthaccessToken

Path parameters

namestringRequired

The queue name

Example: queue-1

jobIdstringRequired

The job id

Example: 1234567890

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/services/queues/{name}/jobs/{jobId}/logs

HTTPcURLJavaScriptPython

GET /api/administration/services/queues/{name}/jobs/{jobId}/logs HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "logs": [
    "[INFO] Job started"
  ],
  "count": 10
}

Get transactions

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/transactions

Get transactions by admin

Authorizations

bearerAuthaccessToken

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

namestring · enumOptional

Filter transactions by type

Possible values:

statusstring · enumOptional

The transaction status

Possible values:

userIdstringOptional

Filter by the user ID

Example: 000000000000000000000001

organizationIdstringOptional

Filter by the organization ID

Example: 6751b0c2ae096d178b017a1e

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/transactions

HTTPcURLJavaScriptPython

GET /api/administration/transactions HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "name": "project-creation",
      "status": "in-progress",
      "stages": [
        {
          "name": "text",
          "status": "failed",
          "payload": "text",
          "result": "text",
          "error": "text"
        }
      ],
      "userId": "63ea10b94a472e003305232b",
      "organizationId": "63ea10b94a472e003305232b",
      "user": {
        "_id": "63ea10b94a472e003305232b",
        "username": "[email protected]",
        "language": "en",
        "region": "us",
        "firstName": "John",
        "lastName": "Doe",
        "status": 1,
        "attributes": {
          "iamUserId": "1234567890"
        },
        "avatarUrl": "text",
        "settings": {
          "mailOnBuildCompleted": true,
          "mailOnCodePushCompleted": true
        },
        "lastLoginAt": "2020-07-23T12:00:00.000Z",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Get a transaction

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/transactions/{transactionId}

Get a transaction by admin

Authorizations

bearerAuthaccessToken

Path parameters

transactionIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/administration/transactions/{transactionId}

HTTPcURLJavaScriptPython

GET /api/administration/transactions/{transactionId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "project-creation",
  "status": "in-progress",
  "stages": [
    {
      "name": "text",
      "status": "failed",
      "payload": "text",
      "result": "text",
      "error": "text"
    }
  ],
  "userId": "63ea10b94a472e003305232b",
  "organizationId": "63ea10b94a472e003305232b",
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Project service integrations

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/service-integrations/{model}/{localId}

Project service integrations

Authorizations

bearerAuthaccessToken

Path parameters

modelstring · enumRequired

AppMaker model name

Possible values:

localIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/administration/service-integrations/{model}/{localId}

HTTPcURLJavaScriptPython

GET /api/administration/service-integrations/{model}/{localId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "63ea10b94a472e003305232b",
    "type": 1,
    "remoteId": 1234567890,
    "localId": "6131198510b4640b303ebf1b",
    "model": "project",
    "enabled": true,
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  }
]

Project service integrations

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/administration/service-integrations/{serviceIntegrationId}

Project service integrations

Authorizations

bearerAuthaccessToken

Path parameters

serviceIntegrationIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

Body

application/json

enabledbooleanRequired

The service integration enabled

Example: true

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/administration/service-integrations/{serviceIntegrationId}

HTTPcURLJavaScriptPython

PATCH /api/administration/service-integrations/{serviceIntegrationId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}

{
  "_id": "63ea10b94a472e003305232b",
  "type": 1,
  "remoteId": 1234567890,
  "localId": "6131198510b4640b303ebf1b",
  "model": "project",
  "enabled": true,
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}