Getting Started with env zero API

Introduction

This document describes the resources that make up the official env zero REST API.

Base URL

https://api.env0.com

Content types

All requests should be in JSON format and include the accept: application/json header.

Authentication

HTTP Basic authentication. Send the API Key ID as the username and the API Key Secret as the password. Keys are created under Organization Settings -> API Keys (Admin or User scope) or Personal Settings -> API Keys (Personal scope).

Scope of this document

This specification covers the environment drift-governance surface of the env zero API and the environment, deployment, template, configuration and project endpoints that support it. It was reconstructed from the OpenAPI fragments published on https://docs.envzero.com and is a subset of the full API.

Error responses

401 and 403 responses return { "message": string } and are documented on every operation. The upstream documentation does not define response bodies for other non-2xx status codes, so none are asserted here.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install ezero-apimatic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/ezero-apimatic-sdk/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from envzeroapi.configuration import Environment
from envzeroapi.envzeroapi_client import EnvzeroapiClient
from envzeroapi.http.auth.basic_auth import BasicAuthCredentials
from envzeroapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from envzeroapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from envzeroapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = EnvzeroapiClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='BasicAuthUserName',
        password='BasicAuthPassword'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from envzeroapi.envzeroapi_client import EnvzeroapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = EnvzeroapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

• env0_API_Key (Basic Authentication)

List of APIs

• Bulk Operations
• Deployment Logs
• Approval Policy
• Environment Outputs
• Environments
• Drift
• Scheduling
• Templates
• Configuration
• Projects
• Organization
• Notifications
• Credentials

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime