Envvar

Manage project environment variables.

Get organizations project envvars

get
/organizations/{organizationId}/projects/{projectId}/settings/envvars

Get organizations project envvars by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/settings/envvars
GET /api/v1/organizations/{organizationId}/projects/{projectId}/settings/envvars HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "_id": "63ea10b94a472e003305232b",
    "name": "MY_ENV_VAR",
    "value": "my_value",
    "isSecret": false,
    "env": "production",
    "authorId": "text",
    "createdAt": "2025-12-06T06:30:01.984Z",
    "updatedAt": "2025-12-06T06:30:01.984Z"
  }
]

Create a organization project envvar

post
/organizations/{organizationId}/projects/{projectId}/settings/envvars

Create a organization project envvars by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
namestringRequired

Envvar name, formatted as UPPER_SNAKE_CASE

Example: <name>
valuestringRequired

Envvar value

Example: <value>
envstring · enumRequired

Envvar environment

Example: <env>Possible values:
isSecretbooleanOptional

Envvar is secret

Default: falseExample: <isSecret>
Responses
post
/organizations/{organizationId}/projects/{projectId}/settings/envvars
POST /api/v1/organizations/{organizationId}/projects/{projectId}/settings/envvars HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "name": "<name>",
  "value": "<value>",
  "env": "<env>",
  "isSecret": "<isSecret>"
}
{
  "_id": "text",
  "name": "text",
  "slug": "text",
  "description": "text",
  "organization": "text",
  "credential": {},
  "additionalCredentials": {},
  "storeCredentials": {
    "googlePlay": {
      "googleServiceFile": "text",
      "packageName": "text"
    },
    "appleAppStore": {
      "keyId": "ABCDEFGHIJ",
      "keyIssuerId": "12345678-1234-1234-1234-123456789012",
      "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
      "keyInHouse": true,
      "appIdentifier": "com.akinon.test",
      "teamId": "ABCDEFGHIJ",
      "teamName": "Akinon Team",
      "appSpecificId": 1234567890
    },
    "huaweiAppGallery": {
      "clientId": "text",
      "clientSecret": "text"
    }
  },
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      }
    },
    "huawei": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      }
    },
    "ios": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text"
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text"
      }
    }
  },
  "status": "draft",
  "lastActivityAt": "2025-12-06T06:30:01.984Z",
  "appIconUrl": "text",
  "createdAt": "2025-12-06T06:30:01.984Z",
  "updatedAt": "2025-12-06T06:30:01.984Z"
}

Get organizations a project envvar

get
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Get a organization project envvar by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
envvarIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}
GET /api/v1/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "_id": "63ea10b94a472e003305232b",
  "name": "MY_ENV_VAR",
  "value": "my_value",
  "isSecret": false,
  "env": "production",
  "authorId": "text",
  "createdAt": "2025-12-06T06:30:01.984Z",
  "updatedAt": "2025-12-06T06:30:01.984Z"
}

Delete a project envvar

delete
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Delete a project envvar by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
envvarIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
delete
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}
DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a project envvar

patch
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Update a project envvar by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
envvarIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
valuestringOptional

Envvar value

Example: <value>
Responses
200

OK

application/json
Responseall of
and
patch
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}
PATCH /api/v1/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "value": "<value>"
}
{
  "_id": "text",
  "name": "text",
  "slug": "text",
  "description": "text",
  "organization": "text",
  "credential": {},
  "additionalCredentials": {},
  "storeCredentials": {
    "googlePlay": {
      "googleServiceFile": "text",
      "packageName": "text"
    },
    "appleAppStore": {
      "keyId": "ABCDEFGHIJ",
      "keyIssuerId": "12345678-1234-1234-1234-123456789012",
      "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
      "keyInHouse": true,
      "appIdentifier": "com.akinon.test",
      "teamId": "ABCDEFGHIJ",
      "teamName": "Akinon Team",
      "appSpecificId": 1234567890
    },
    "huaweiAppGallery": {
      "clientId": "text",
      "clientSecret": "text"
    }
  },
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      }
    },
    "huawei": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text",
        "versionCode": 1
      }
    },
    "ios": {
      "production": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text"
      },
      "staging": {
        "createdAt": "text",
        "deploymentId": "text",
        "envVersion": "text",
        "publishedAt": "text",
        "publisher": "text",
        "status": true,
        "storeVersion": "text",
        "tag": "text",
        "updatedAt": "text"
      }
    }
  },
  "status": "draft",
  "lastActivityAt": "2025-12-06T06:30:01.984Z",
  "appIconUrl": "text",
  "createdAt": "2025-12-06T06:30:01.984Z",
  "updatedAt": "2025-12-06T06:30:01.984Z"
}

Last updated

Was this helpful?