Agents¶

class terrasnek.agents.TFCAgents(instance_url, org_name, headers, well_known_paths, verify, log_level)¶

create_pool(payload)¶

POST /organizations/:organization_name/agent-pool

destroy(agent_pool_id)¶

DELETE /agent-pools/:agent_pool_id

list(agent_pool_id, filters=None)¶

GET /agent-pools/:agent_pool_id/agents

Query Parameter(s) (details):

Example filter(s):

filters = [
    {
        "keys": ["last-ping-since"],
        "value": "foo"
    }
]

list_pools()¶

GET /organizations/:organization_name/agent-pools

required_entitlements()¶: Terraform Cloud Entitlements required for endpoint to work.

show(agent_id)¶

GET /agents/:id

show_pool(agent_pool_id)¶

GET /agent-pools/:id

terraform_cloud_only()¶: Return True if this endpoint is only for Terraform Cloud, else False.

terraform_enterprise_only()¶: Return True if this endpoint is only for Terraform Enterprise, else False.

update(agent_pool_id, payload)¶

PATCH /agent-pools/:id

terrasnek