Skip to main content
POST
/
modules
Create module
curl --request POST \
  --url https://api.env0.com/modules \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": "<string>",
  "author": {
    "email": "<string>",
    "user_id": "<string>",
    "created_at": "<string>",
    "app_metadata": {},
    "picture": "<string>",
    "name": "<string>",
    "last_login": "<string>",
    "given_name": "<string>",
    "family_name": "<string>"
  },
  "authorId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isDeleted": true,
  "type": "<string>",
  "repository": "<string>",
  "description": "<string>",
  "tokenId": "<string>",
  "tokenName": "<string>",
  "githubInstallationId": 123,
  "bitbucketClientKey": "<string>",
  "isGitLab": true,
  "isAzureDevOps": true,
  "isBitbucketServer": true,
  "isGitHubEnterprise": true,
  "isGitLabEnterprise": true,
  "path": "<string>",
  "runTestsOnPullRequest": true,
  "opentofuVersion": "<string>",
  "tagPrefix": "<string>",
  "vcsConnectionId": "<string>",
  "moduleName": "<string>",
  "moduleProvider": "<string>",
  "moduleTestEnabled": true
}'
{
  "id": "<string>",
  "organizationId": "<string>",
  "author": {
    "email": "<string>",
    "user_id": "<string>",
    "created_at": "<string>",
    "app_metadata": {},
    "picture": "<string>",
    "name": "<string>",
    "last_login": "<string>",
    "given_name": "<string>",
    "family_name": "<string>"
  },
  "moduleName": "<string>",
  "moduleProvider": "<string>",
  "moduleTestEnabled": true,
  "repository": "<string>",
  "description": "<string>",
  "tokenId": "<string>",
  "tokenName": "<string>",
  "githubInstallationId": 123,
  "bitbucketClientKey": "<string>",
  "isGitLab": true,
  "isAzureDevOps": true,
  "isBitbucketServer": true,
  "isGitHubEnterprise": true,
  "isGitLabEnterprise": true,
  "path": "<string>",
  "runTestsOnPullRequest": true,
  "opentofuVersion": "<string>",
  "tagPrefix": "<string>",
  "vcsConnectionId": "<string>",
  "type": "<string>",
  "testingEnvironmentId": "<string>",
  "authorId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isDeleted": true
}

Authorizations

​
Authorization
string
header
required

env0 API authentication is done via API keys. An API Key can either be created by an organization administrator, in which case it will not be connected to any specific user, or via Personal API Keys to authenticate as a user.

Creating an API Key with a Specific Role

  • Once you've created your organization, you can set up and manage API Keys.

  • Navigate to the Organization Settings page and click the API Keys tab.

  • Click Add API Key and enter a name for your key in the Name field. This name is for reference purposes only and isn't used directly in authentication.

    ❗️Save Your API Key ID and secret The secret will not be available after you close this window.

Creating a Personal API Key

  • Click on your avatar (located on the top right of the screen)

  • Click on Personal Settings

  • Select the API Keys tab

  • Click Add API Key, and enter a name for your key in the Name field. This name is for reference purposes and isn't used directly in authentication.

    ❗️Save your API Key ID & secret The secret will not be available after you close this window.

Using an API Key to Authenticate

Authentication of the env0 API is done using the Basic Authentication method. Each request made should include the API Key ID as the username, and the API Key secret as the password. For example, when using curl, we can include these parameters via flag --user {API Key ID}:{API Key Secret}.

API Key Permissions

When creating an API key through the organization settings, you will need to choose if you’d like to grant it Organization Admin or User permissions. In case of the latter, you can assign fine-grained permissions per project. Personal API Keys can be created through the user’s profile page and will have the same permissions as the user has.

Rate Limits

env0 API allows up to 1K requests per 60 seconds, requests are aggregated by IP, HTTP Method and URI. If you exceed this limit, you will receive a 429 status code.

Body

application/json
​
organizationId
string
required
​
type
string
required
Allowed value: "module"
​
repository
string
required
​
moduleName
string
required

Module Name. Can be made of up to 64 characters, containing alphanumeric, hyphens and underscores. Must not contain leading/trailing hyphens/underscores.

​
moduleProvider
string
required

Module Provider. Can be made of up to 64 characters, containing lowercase alphanumeric characters only.

​
author
object
​
authorId
string
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
isDeleted
boolean
​
description
string
​
tokenId
string
​
tokenName
string
​
githubInstallationId
number | null
​
bitbucketClientKey
string | null
​
isGitLab
boolean
​
isAzureDevOps
boolean
​
isBitbucketServer
boolean
​
isGitHubEnterprise
boolean
​
isGitLabEnterprise
boolean
​
path
string
​
runTestsOnPullRequest
boolean
​
opentofuVersion
string
​
tagPrefix
string
​
vcsConnectionId
string | null
​
moduleTestEnabled
boolean

Response

200 - application/json
​
organizationId
string
required
​
moduleName
string
required

Module Name. Can be made of up to 64 characters, containing alphanumeric, hyphens and underscores. Must not contain leading/trailing hyphens/underscores.

​
moduleProvider
string
required

Module Provider. Can be made of up to 64 characters, containing lowercase alphanumeric characters only.

​
repository
string
required
​
type
string
required
Allowed value: "module"
​
id
string
​
author
object
​
moduleTestEnabled
boolean
​
description
string
​
tokenId
string
​
tokenName
string
​
githubInstallationId
number | null
​
bitbucketClientKey
string | null
​
isGitLab
boolean
​
isAzureDevOps
boolean
​
isBitbucketServer
boolean
​
isGitHubEnterprise
boolean
​
isGitLabEnterprise
boolean
​
path
string
​
runTestsOnPullRequest
boolean
​
opentofuVersion
string
​
tagPrefix
string
​
vcsConnectionId
string | null
​
testingEnvironmentId
string
​
authorId
string
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
isDeleted
boolean
⌘I