Codefresh
API integration

list_all_codefresh_abacs

List the ABAC access-control rules in Codefresh. Returns a JSON object whose fields are not enumerated in the upstream spec.

create_a_codefresh_abac

Create an ABAC access-control rule in Codefresh by posting a JSON rule definition. Returns a JSON object whose fields are not enumerated in the upstream spec.

get_single_codefresh_abac_by_id

Get a single ABAC access-control rule in Codefresh by id. Returns a JSON object whose fields are not enumerated in the upstream spec. Required: rule.

codefresh_abacs_bulk_delete

Delete an ABAC access-control rule in Codefresh by id. Returns a JSON object whose fields are not enumerated in the upstream spec. Required: rule.

delete_a_codefresh_abac_batch_by_id

Create or delete Codefresh ABAC permission rules in a single batch. Returns a JSON response object (upstream documents no field breakdown for it). Requires a request body containing a create array of rule definitions (teams, actions, resource, relatedResource, tags) and/or a delete array of rule ids.

list_all_codefresh_abac_resources

Get the ABAC rules defined for a specific resource in Codefresh. Returns the matching rules as an opaque JSON object (field structure not documented upstream). Required: resource.

update_a_codefresh_tags_rule_by_id

Update the tags assigned to a Codefresh ABAC rule. Returns a JSON object response confirming the update. Required: rule.

create_a_codefresh_tags_rule

Create tags for one or more Codefresh ABAC rules in a single call. Sends a JSON body with tags and rules arrays and returns a JSON object response confirming the tag assignment.

get_single_codefresh_abac_team_by_id

Get the ABAC rules assigned to a team in Codefresh by team id. Returns the team's rules payload as a JSON object; the upstream API documents the response only as a JSON object and does not enumerate the individual rule fields. Required: id.

create_a_codefresh_abac_team_rule

Create ABAC team rules in batch in Codefresh, applying the same resource, relatedResource, actions, and tags to multiple teams in one call. Returns a JSON object; the upstream API does not enumerate the response fields. Requires a JSON request body with teams, actions, resource, relatedResource, and tags.

list_all_codefresh_github_actions

List GitHub actions in Codefresh matching a search query by name. Returns matching records with an id and action-specific attributes. Required: text.

get_single_codefresh_github_action_context_by_id

Get the github action context for a specific github action in Codefresh by id. Returns the context as an opaque JSON object; the API spec does not document its individual fields. Required: id.

list_all_codefresh_analytics_reports

Get an analytics report by name from the Codefresh Analytics API. Returns a JSON payload whose fields are report-specific and vary by report name.g. creditConsumption, pipelineCreditConsumption, activeCommitters). Supported granularity and date-range windows differ per report; omit granularity for aggregated totals. Required: report_name.

list_all_codefresh_analytics_metadata

List analytics metadata in Codefresh — the discovery endpoint for Platform Analytics, returning the reports available through the reports endpoint and the parameters each supports. Returns the metadata as a generic JSON object whose structure is not publicly enumerated upstream; report names, supported granularities, and time ranges vary per report.

list_all_codefresh_etl_type_last_success_times

Get the last successful run time for an analytics ETL type in Codefresh. Returns a JSON object describing the last successful ETL time for the requested type.

delete_a_codefresh_account_by_id

Request deletion of a Codefresh account by id. Returns an untyped JSON object whose fields the upstream documentation does not enumerate. Required: id.

codefresh_accounts_bulk_delete

Remove a user from a Codefresh account by account_id and user_id. Returns an untyped JSON object whose fields the upstream documentation does not enumerate. Documented upstream as not yet implemented. Required: account_id, user_id.

create_a_codefresh_resend_invite

Resend a Codefresh account invite email to a user. Returns a JSON object confirming the resend on success (the upstream spec does not enumerate its fields). Required: account_id, user_id.

create_a_codefresh_adduser

Add existing user to account. Required: account_id, user_id.

create_a_codefresh_admin

Set a user as an admin of a Codefresh account. Returns a JSON object; Codefresh documents the response as an untyped object and does not enumerate its fields. Required: account_id, user_id.

codefresh_admins_bulk_delete

Remove a user's admin role from a Codefresh account. Returns a JSON object; Codefresh documents the response as an untyped object and does not enumerate its fields. Required: account_id, user_id.

create_a_codefresh_account_adduser

Add a user to a Codefresh account, specifying the user by email address or an existing Codefresh user name. Returns a JSON object response; the upstream API does not enumerate the returned fields. Required: account_id.

create_a_codefresh_account_update

Update the public settings of a Codefresh account, sending a settings object with integration configuration and notification entries (webhook or Slack). Returns a JSON object; the upstream does not document its fields. The upstream marks this settings schema as still being defined. Required: account_id.

create_a_codefresh_updateuser

Update user details for a user in a Codefresh account. Returns the updated user object as JSON. Required: account_id, user_id.

list_all_codefresh_account_users

List users of a Codefresh account by its id. Returns the account's users as a JSON object; the upstream docs do not enumerate the response fields. Required: account_id.

list_all_codefresh_account_settings

Get the Codefresh account settings. Returns: schemaVersion, updatedAt, settings.

update_a_codefresh_account_setting_by_id

Update the Codefresh account settings. Returns the updated account settings object: schemaVersion, updatedAt, settings.

list_all_codefresh_admin_accounts

List all Codefresh accounts in the system. Returns each account with its id, name, and provider.

create_a_codefresh_admin_account

Create a new account in Codefresh. Returns the created account with its id, name, and provider. Required: name.

get_single_codefresh_admin_account_by_id

Get a single Codefresh account by id. Returns the account object with its id, name, and provider. Required: id.

delete_a_codefresh_admin_account_by_id

Delete a Codefresh account by id. Returns an empty 204 response on success. The upstream API lists this endpoint as not yet implemented. Required: id.

list_all_codefresh_archive_lists

List entries from the Codefresh account archive via the admin API. Returns a JSON object; the upstream documentation does not enumerate its fields.

create_a_codefresh_accounts_addpendinguser

Add a pending user without an account in Codefresh. Returns a JSON object that includes _id. Required: provider, userName.

create_a_codefresh_account_segment

Set the account segment for a Codefresh account, supplying the segment payload (e.g. trial details such as trialing, trialStart, trialEnd). Returns: a JSON object on success (the upstream spec does not enumerate its response fields). Required: account_id, segment_type.

create_a_codefresh_account_rename

Rename a Codefresh account via the admin API. Returns a JSON object on success; the upstream API does not document the response fields. Required: account_id.

list_all_codefresh_admin_runtime_environments

List Codefresh admin runtime environments. Returns one record per environment, including its name plus a free-form attributes object holding the remaining runtime-environment fields (not enumerated upstream).

get_single_codefresh_admin_runtime_environment_by_id

Get a Codefresh admin runtime environment by id (its runtime environment name, e.g. 'my-aws-runner/cf'). Returns the record's name plus a free-form attributes object holding the remaining runtime-environment fields (not enumerated upstream). Required: id.

delete_a_codefresh_admin_runtime_environment_by_id

Delete a Codefresh admin runtime environment by id (its runtime environment name). Returns an unspecified JSON object on success; the upstream docs do not enumerate its fields. Required: id.

codefresh_admin_runtime_environments_set_default

Set the default Codefresh admin runtime environment for a plan. Returns the record's name plus a free-form attributes object holding the remaining runtime-environment fields (not enumerated upstream). Required: plan, runtime_environment_name.

update_a_codefresh_admin_runtime_environment_by_id

Update (upsert) a Codefresh admin runtime environment by id (its runtime environment name) with a JSON request body. Returns the record's name plus a free-form attributes object holding the remaining runtime-environment fields (not enumerated upstream). Required: id.

list_all_codefresh_runtime_environments_accounts

List runtime environments associated with a Codefresh account, optionally filtered by account ids. Returns a JSON object whose fields are not enumerated in the upstream spec. Required: account.

codefresh_runtime_environments_accounts_bulk_update

Set the default runtime environment for a Codefresh account by runtime environment name. Returns a JSON object whose fields are not enumerated in the upstream spec. Required: account, runtime_environment_name.

codefresh_account_modifies_bulk_update

Add a runtime environment to the Codefresh account, identified by its runtime environment name. Returns a JSON response object; the upstream spec does not document its fields. Required: runtime_environment_name.

codefresh_account_modifies_bulk_delete

Remove a runtime environment from the Codefresh account, identified by its runtime environment name. Returns a JSON response object; the upstream spec does not document its fields. Required: runtime_environment_name.

create_a_codefresh_runtime_environments_health_check

Submit a health-check report from a runtime environment cluster to Codefresh. Returns a generic JSON object acknowledgment whose fields are not documented upstream.

codefresh_admin_users_activate

Activate a Codefresh admin user by id. Returns an unenumerated JSON object on success (the upstream API spec does not document the response fields). Required: user_id.

codefresh_admin_users_bulk_delete

Delete a Codefresh admin user by user name. Returns an unenumerated JSON object on success (the upstream API spec does not document the response fields). Required: user_name.

create_a_codefresh_user_admin_role

Change the admin role assigned to a Codefresh user. Returns a JSON object; the upstream API does not enumerate the fields of this response. The request body identifies the target user by its _id and userName.

create_a_codefresh_user_account

Change the account settings for a Codefresh user via the admin API. Returns a JSON object on success; the upstream API specification does not enumerate its fields.

list_all_codefresh_user_login_as_users

Log in to Codefresh as another user by supplying their user id (admin operation). Returns an opaque 200 JSON response; the API documents no specific fields for this response.

create_a_codefresh_user_local_provider

Update a Codefresh user's local authentication provider by setting a new password. Returns an unspecified JSON object; the API documents no response fields.

codefresh_user_local_providers_bulk_delete

Delete a Codefresh user's local (password-based) authentication provider. Returns an unspecified JSON object; the API documents no response fields.

create_a_codefresh_admin_idp

Create an IDP (identity provider client) configuration in Codefresh. Returns the created IDP record including its _id. Sends the clientName and clientType body fields.

delete_a_codefresh_admin_idp_by_id

Delete a Codefresh IDP (identity provider client) by id. Returns: _id. Required: id.

codefresh_admin_idps_bulk_update

Update a Codefresh IDP (identity provider client) configuration. Returns the updated IDP record including its _id. Sends the clientName and clientType body fields.

create_a_codefresh_idp_add_account

Add an account to an IDP configuration in Codefresh via the admin API. Returns a JSON object whose response fields are not enumerated in the API spec.

codefresh_analytic_add_accounts_bulk_update

Add an account to Codefresh analytics by name. Returns a JSON object response on success; the upstream docs do not enumerate the response fields. Only name is accepted in the body.

create_a_codefresh_admin_customer

Create a new customer in Codefresh by sending the customer definition as a JSON object body. Returns the created customer record, identified by its id.

create_a_codefresh_assign_account_to_customer

Assign an existing account to a customer in Codefresh. Returns a JSON object confirming the assignment (the API does not document its fields). Required: customer_id, account_id.

codefresh_customer_update_customer_limits_bulk_update

Update the limits of a Codefresh customer. Returns a 200 JSON object whose fields the upstream API does not enumerate. Required: customer_id.

create_a_codefresh_detach_account_from_customer

Detach an account from a customer in Codefresh. Executes the admin-level detach action for the given customer and account pair and returns a JSON response object (the upstream spec does not document its fields). Required: customer_id, account_id.

create_a_codefresh_add_customer_admin

Add a customer admin in Codefresh by granting admin rights on a customer to a user. Returns a JSON response confirming the assignment. Required: customer_id, user_id.

create_a_codefresh_remove_customer_admin

Remove a user's customer admin privileges for a customer in Codefresh. Returns a JSON object on success; the upstream API does not document the response fields. Required: customer_id, user_id.

create_a_codefresh_approval_approve

Submit an approval in Codefresh by posting a JSON payload to the admin approval action. Returns a JSON object whose fields are not documented upstream.

create_a_codefresh_favorite

Create favorite entities in Codefresh. Returns: n, ok. Requires a JSON body with entities and type (repo, pipeline-branch, or step-type).

list_all_codefresh_favorites

List Codefresh favorites for one entity type. Returns: __v, _id, accountId, userId, type, data, entities. Required: type.

codefresh_favorites_bulk_delete

Delete favorite entities in Codefresh. Returns: n, ok. Requires a JSON body with entities and type (repo, pipeline-branch, or step-type).

get_single_codefresh_entity_by_id

Get the Codefresh favorites for a specific entity by id. Returns an array of favorite records including _id, accountId, userId, type, entities, data, and __v. Required: id, type.

list_all_codefresh_annotations

List Codefresh annotations. Returns an array of annotation objects including _id, accountId, entityId, entityType, key, value, and type.

create_a_codefresh_annotation

Create an annotation in Codefresh for an entity such as a build. Returns the created annotation object including _id, accountId, entityId, entityType, key, value, and type. Accepts entityId, entityType, key, value, and display.

codefresh_annotations_bulk_delete

Delete one or more Codefresh annotations matching the supplied query filters. Returns the deletion result with n (number of annotations deleted) and ok.

update_a_codefresh_annotation_by_id

Update a Codefresh annotation by id. Returns the updated annotation object including _id, accountId, entityId, entityType, key, value, and type. Required: id.

delete_a_codefresh_annotation_by_id

Delete a Codefresh annotation by id. Returns the deleted annotation object including _id, accountId, entityId, entityType, key, value, and type. Required: id.

list_all_codefresh_annotations_keys

List annotation keys in Codefresh. Returns an array of annotation key strings for the given entity type. Required: entity_type.

list_all_codefresh_annotations_values

List the values recorded for a specific annotation key in Codefresh. Returns an array of annotation value strings. Required: entity_type, value_id.

create_a_codefresh_annotations_metadatum

Create annotations in bulk in Codefresh by setting and/or unsetting annotations on multiple entities (e.g. builds) in a single call. Returns the applied operations: set, unset.

get_single_codefresh_key_service_user_by_id

Get a single API key token for a Codefresh service account by id. Returns the token with its id and upstream-defined attributes. Required: id, service_user_id.

update_a_codefresh_key_service_user_by_id

Update an API key token belonging to a Codefresh service account. Returns the updated token with its id and upstream-defined attributes. Required: id, service_user_id.

delete_a_codefresh_key_service_user_by_id

Delete an API key token belonging to a Codefresh service account. Returns a token object with its id and upstream-defined attributes. Required: id, service_user_id.

list_all_codefresh_key_service_users

List the API key tokens issued to a Codefresh service account. Returns each token with its id and upstream-defined attributes. Required: service_user_id.

create_a_codefresh_key_service_user

Generate a new API key token for a Codefresh service account. Returns the created token with its id and upstream-defined attributes. Required: service_user_id.

create_a_codefresh_auth_key

Generate a new Codefresh API key (token). Returns the created key object including its id, name, and scopes.

get_single_codefresh_auth_key_by_id

Get a Codefresh API key by id. Returns the key object including its id, name, and scopes. Required: id.

update_a_codefresh_auth_key_by_id

Update a Codefresh API key by id. Returns the updated key object including its id, name, and scopes. Required: id.

delete_a_codefresh_auth_key_by_id

Delete a Codefresh API key by id. Returns a JSON object on success; the upstream spec does not document the response fields. Required: id.

list_all_codefresh_auth_keys

List the Codefresh API keys for the authenticated account. Returns the API keys, each with its id — the identifier required by the delete method.

list_all_codefresh_audits

List Codefresh audit log entries, filterable by user (userName, userId), entity (entity, entityId), action, response status (rs_status), trigger activity, free-text search, and a millisecond-epoch date range (from, to). Returns: id, createdAt, updatedAt.

list_all_codefresh_audit_users

List the users available for filtering Codefresh audit logs. Returns an untyped JSON payload whose structure is not documented upstream. No required parameters.

list_all_codefresh_audit_entities_lists

List the possible audit-log filter values in Codefresh — the action values usable with the action filter of the audits list endpoint. Returns an untyped JSON object; the API does not document its fields, and only actions that have occurred in the account are returned.

list_all_codefresh_audit_downloads

Download Codefresh audit log records as JSON, filtered by user, entity, action, response status, date range, or a free-text search. Returns audit records with their id, createdAt, and updatedAt. All filters are optional; the download fetches 5 pages of up to 10000 records each (50000 records max).

list_all_codefresh_workflows

List Codefresh workflow builds in a pageable way. Returns each build with its id, status, created and finished timestamps, trigger, pipelineName, revision, branchName, committer, and steps. startDate and endDate must be used together when filtering by date; the trigger filter defaults to 'build'.

get_single_codefresh_status_by_id

Get the current build status of a Codefresh workflow by request id. Returns the status as a plain string, e.g. "success". Required: id.

codefresh_status_bulk_update

Report a health status message for a Codefresh runner agent. Returns an empty response on success. Required: agent_id.

get_single_codefresh_pending_approval_approve_by_id

Approve a pending-approval build (workflow) in Codefresh by its id. Returns the build id of the approved workflow as a plain string. Required: id.

get_single_codefresh_pending_approval_deny_by_id

Deny a pending-approval build in Codefresh identified by its build id. Returns the build id of the successfully denied workflow. Required: id.

get_single_codefresh_use_debugger_by_id

Check whether debug mode is on for an existing Codefresh build. Returns the useDebugger flag — true when debug mode is on for the build, otherwise false. Required: id.

create_a_codefresh_use_debugger

Turn on debug mode for an existing Codefresh build. Returns: OK. Required: workflow_id.

get_single_codefresh_builds_tree_by_id

Get the full or partial builds tree of a specific Codefresh build by id. Returns an opaque JSON object representing the build tree (or graph, when requested), with a structure that varies by representation rather than a fixed field set. Required: id.

get_single_codefresh_build_by_id

Get a single Codefresh build by id. Returns the full build object including id, status, pipelineName, created/started/finished timestamps, trigger details, and the executed steps. Required: id.

get_single_codefresh_builds_rebuild_by_id

Restart a Codefresh build by id. Triggers a rebuild of the specified build and returns the ID of the new build as a bare JSON string (e.g. "602be9cc2294b2b7437acdbb"). Required: id.

get_single_codefresh_builds_rebuild_debug_by_id

Restart a Codefresh build in debug mode by id. Returns the ID of the new debug build as a JSON string (e.g. 602be9cc2294b2b7437acdbb). Required: id.

list_all_codefresh_repos_webhooks

Get the git trigger configuration for a repository in Codefresh. Returns a JSON trigger object; the upstream API documents this response only as a generic object and does not enumerate its fields. Required: repo_owner, repo_name, provider, context.

list_all_codefresh_clusters

List Codefresh clusters. Returns the clusters payload as a JSON object; the upstream API spec does not enumerate its response fields.

delete_a_codefresh_cluster_by_id

Delete a Codefresh cluster for the given provider by id. Returns a JSON object whose fields the upstream API spec does not enumerate. Required: id, provider.

create_a_codefresh_cluster

Create a Codefresh cluster under the given provider. Returns a JSON object whose fields the upstream API spec does not enumerate. Required: provider.

codefresh_clusters_set_tags

Set the tags on a Codefresh cluster identified by cluster_id. Returns a 200 OK response on success; the upstream API spec does not document a response body. Required: cluster_id.

codefresh_clusters_tags

List the tags of a Codefresh cluster identified by cluster_id. Returns a 200 OK response on success; the upstream API spec does not document a response body. Required: cluster_id.

list_all_codefresh_clusters_by_permissions

List Codefresh clusters the authenticated API key has permission to access, based on the account's cluster access-control settings. Returns a JSON object keyed by cluster identifier, with each value holding the cluster's permission details. No required parameters.

create_a_codefresh_local_cluster

Save (register) a local Kubernetes cluster in Codefresh by supplying its host, CA certificate, and service account token. Returns the saved cluster configuration as a JSON object. Requires type, selector, host, clientCa, and serviceAccountToken; type must be `sat`, provider defaults to `local`, encoding defaults to `utf-8`, and providerAgent should be `custom` for local clusters. Required: type, selector, host, clientCa, serviceAccountToken.

create_a_codefresh_clusters_revoke

Revoke an account's access to a cluster provider in Codefresh. Returns an empty 200 response on success. Required: provider.

list_all_codefresh_clusters_tags

List all cluster tags in Codefresh. Returns the collection of tags assigned to clusters; the upstream spec documents only a 200 ok response with no field-level schema, so the exact tag shape is not enumerated.

list_all_codefresh_cluster_credentials

List the credentials for a specific Kubernetes cluster in Codefresh. Returns the cluster's credential details. Required: cluster_id.

get_single_codefresh_cluster_helm_version_by_id

Get the Helm version for a Kubernetes cluster in Codefresh. Returns the cluster's Helm version as an opaque response — the upstream API documents only a 200 ok response and does not enumerate the body fields. Required: id.

list_all_codefresh_clusters_s

Forward a GET request through the Codefresh clusters proxy (path /api/clusters/*) to the configured cluster provider. Returns an untyped JSON object from the provider whose fields depend on the specific sub-path invoked; the API spec does not enumerate them.

create_a_codefresh_clusters

Forward a POST request, including any request payload, through the Codefresh clusters proxy (path /api/clusters/*) to the configured cluster provider. Returns an untyped JSON object from the provider whose fields depend on the specific sub-path invoked; the API spec does not enumerate them.

codefresh_clusters_s_bulk_update

Update a cluster resource in Codefresh through the cluster-provider proxy (proxy PUT). Sends the supplied JSON payload as-is to the upstream cluster provider, which returns an opaque, provider-specific JSON response (fields depend on the provider and are not documented by Codefresh).

codefresh_clusters_s_bulk_delete

Delete a cluster resource in Codefresh through the cluster-provider proxy. The request is forwarded to the upstream cluster provider, which returns an opaque, provider-specific JSON response (fields depend on the provider and are not documented by Codefresh).

list_all_codefresh_compositions

List Codefresh compositions. Returns the composition records including _id, name, account, created, and yamlJson.

create_a_codefresh_composition

Create a Codefresh composition. Returns the created composition record including name, isAdvanced, vars, and yamlJson.

get_single_codefresh_composition_by_id

Get a single Codefresh composition by id or name. Returns the composition record with _id, name, account, created, vars, and yamlJson. Required: id.

update_a_codefresh_composition_by_id

Update the name, variables, or YAML body of a Codefresh composition by id. Returns the updated composition record including name, isAdvanced, vars, and yamlJson. Required: id.

delete_a_codefresh_composition_by_id

Delete a Codefresh composition by id. Returns a 200 JSON object on success; the upstream API does not enumerate the fields of this response. Required: id.

codefresh_compositions_duplicate

Duplicate an existing Codefresh composition. Returns a 200 JSON object on success; the upstream API does not enumerate the fields of this response. Required: composition_id.

codefresh_compositions_bulk_update

Partially update a Codefresh composition, sending only the fields to change. Returns the patched composition record including _id, name, vars, yamlJson, and isAdvanced. Required: composition_id.

create_a_codefresh_composition_run

Launch a run of a Codefresh composition, addressed by its id or name. Returns a generic JSON object; the API documentation does not enumerate the response fields. Required: identifier.

list_all_codefresh_contexts

List Codefresh shared configuration contexts (the variable sets pipelines reference via spec.contexts). The upstream API schema does not enumerate the response fields — it types the body as an untyped JSON object whose shape varies by context type. Optional filters: type and decrypt.

create_a_codefresh_context

Create a shared configuration context in Codefresh — a variable set pipelines reference via spec.contexts. Returns the created context object; the upstream API schema does not enumerate its fields. The request body takes spec, whose data object carries the context's variables.

get_single_codefresh_context_by_id

Get a single Codefresh shared configuration context by name. Returns an untyped JSON object for the context; the API schema does not enumerate its fields. Optional: decrypt to retrieve decrypted values. Required: id.

delete_a_codefresh_context_by_id

Delete a Codefresh shared configuration context by name. Returns a 200 JSON object whose fields the upstream API schema does not enumerate. Required: id.

codefresh_contexts_partial_update

Partially update a Codefresh shared configuration context by name. Returns an untyped JSON object; the upstream API schema does not enumerate its fields. The request body takes spec, whose data object carries the context's variables. Required: id.

codefresh_contexts_set_default

Patch a Codefresh shared configuration context by name, updating its spec.data payload. Returns: completed, keysRemoved. Required: name.

update_a_codefresh_context_by_id

Replace a Codefresh configuration context by id (the context name), writing its new spec.data payload. Returns: completed, keysRemoved. Required: id.

create_a_codefresh_cache_clear

Clear the git provider response cache for a Codefresh context. Returns: completed, keysRemoved. If completed is false, some cache entries were left in place and the clear should be retried. Required: name.

list_all_codefresh_context_prepares

Prepare a Codefresh configuration context by name. Returns a JSON object with the prepared context details; the upstream API does not enumerate its fields. Required: name.

create_a_codefresh_customer_create_account

Create a new account under a specific Codefresh customer. Returns a JSON object whose fields are not enumerated in the Codefresh API spec. Required: customer_id.

create_a_codefresh_update_account_limit

Update the account limits for a Codefresh account. Returns a 200 JSON response; the upstream spec does not enumerate the returned fields. Required: customer_id, account_id.

list_all_codefresh_environments

List Codefresh environments. Returns the collection of environment records, each including its id.

get_single_codefresh_environment_by_id

Get a single Codefresh environment by id. Returns the environment record including its id. Required: id.

codefresh_environments_pause

Pause a Codefresh environment by id. Returns the environment record including its id. Required: environment_id.

codefresh_environments_start

Start a paused Codefresh environment by id. Returns the environment record including its id. Required: environment_id.

codefresh_environments_stop

Stop a Codefresh environment by id. Returns the environment record including its id. Required: environment_id.

list_all_codefresh_all_terminates

Terminate all Codefresh environments with a single call. Requires no parameters. Returns an unspecified JSON response on success.

list_all_codefresh_environment_renames

Rename a Codefresh runtime environment by id, assigning it the new name new_name (GET variant of the rename operation). Returns the operation's JSON response object; upstream documents an untyped object without enumerated fields. Required: new_name, env_id.

create_a_codefresh_environment_rename

Rename a Codefresh runtime environment by id, assigning it the new name new_name (POST variant of the rename operation). Returns the operation's JSON response object; upstream documents an untyped object without enumerated fields. Required: new_name, env_id.

get_single_codefresh_environment_status_by_id

Get the current status of a Codefresh environment by id. Returns a JSON status object whose fields are not enumerated in the upstream API documentation. Required: id.

get_single_codefresh_environment_terminate_by_id

Terminate a Codefresh environment by id. Returns a JSON object on success; the upstream API specification does not document the response's fields. Required: id.

get_single_codefresh_environment_unpause_by_id

Unpause a paused Codefresh environment by id. Returns an opaque JSON object whose fields the upstream API does not document. Required: id.

list_all_codefresh_execution_contexts_tags

List all tags used by Codefresh account execution contexts. Returns an array of tag name strings (each tag is a string, e.g. one used for ABAC assignment of an execution context). No required parameters.

list_all_codefresh_execution_contexts_defaults

Get the current default execution context for the Codefresh account. Returns: _id, name, description, account, accountDefault, createdAt, updatedAt, tags, completed, keysRemoved.

update_a_codefresh_execution_contexts_default_by_id

Set an execution context in Codefresh as the account default, replacing the current default. Returns: _id, name, description, account, accountDefault, createdAt, updatedAt, tags. Required: id.

list_all_codefresh_execution_context_assignments

List Codefresh pipeline assignments for an execution context. Returns: account, pipelineId, executionContextId. Required: execution_context_id.

list_all_codefresh_execution_contexts

List Codefresh execution contexts for the account, filtered by optional id, name, tags, or accountDefault parameters. Returns execution contexts including _id, name, description, account, accountDefault, createdAt, updatedAt, and tags.

create_a_codefresh_execution_context

Create a Codefresh execution context that assigns permissions for running pipelines. Returns the created execution context including _id, name, description, account, accountDefault, createdAt, updatedAt, and tags.

get_single_codefresh_execution_context_by_id

Get the current session execution context in Codefresh. Returns the execution context including _id, name, description, account, accountDefault, createdAt, updatedAt, and tags.

update_a_codefresh_execution_context_by_id

Update fields of a Codefresh execution context by id. Returns the updated execution context including _id, name, description, account, accountDefault, updatedAt, and tags. Required: id.

delete_a_codefresh_execution_context_by_id

Delete a Codefresh execution context by id; deletion only succeeds when the context is not in use and is not the account default. Returns: name, description, createdAt, updatedAt. Required: id.

get_single_codefresh_feature_by_id

Get the feature configuration for a Codefresh account by id. Returns the account's feature record including its id. Required: id.

create_a_codefresh_feature

Add (enable) a feature for a Codefresh account by posting the feature name to the account's features endpoint. Returns a JSON object whose shape is not documented upstream. Required: feature_id.

update_a_codefresh_features_switch_off_by_id

Disable a feature on a Codefresh account by id, naming the feature to switch off in the request body. Returns a JSON object whose fields are not documented upstream. Required: id.

create_a_codefresh_form_metadata_create

Create form metadata in Codefresh. Returns the created form metadata record including its _id.

codefresh_form_metadata_updates_bulk_update

Update form metadata in Codefresh identified by its metadata name. Returns the updated form metadata as a JSON object. Required: name.

codefresh_form_metadatas_bulk_delete

Delete a form metadata in Codefresh by its metadata name. Returns a JSON object whose fields the upstream API does not document. Required: name.

codefresh_form_metadata_activates_bulk_update

Activate a form metadata entry in Codefresh by setting it as active within its metadata group. Returns the updated form metadata as a JSON object (upstream documents no specific response fields). Required: group_id, name.

list_all_codefresh_helm_boards

List all Codefresh Helm boards. Returns an array of board objects including _id, name, filter, type, and accountId.

create_a_codefresh_helm_board

Create a Codefresh Helm board. Returns the created board object including _id, name, filter, type, and accountId. Requires a request body with name and filter.

codefresh_helm_boards_bulk_delete

Delete all Codefresh Helm boards at once. Returns the deletion result including n (number of boards deleted) and ok. This operation is account-wide and cannot be scoped to a single board id.

get_single_codefresh_helm_board_by_id

Get a single Codefresh Helm board by id. Returns the board object including _id, name, filter, type, and accountId. Required: id.

update_a_codefresh_helm_board_by_id

Update a Codefresh Helm board by id. Returns the updated board object including _id, name, filter, type, and accountId. Required: id.

delete_a_codefresh_helm_board_by_id

Delete a Helm board in Codefresh by id. Returns the deleted board object including _id, name, filter, accountId, type, and __v. Required: id.

codefresh_helm_boards_bulk_update

Update a Helm board in Codefresh by patching its name or filter. Returns the updated board object including _id, name, filter, accountId, type, and __v. Requires board_id and a JSON body with name and/or filter. Required: board_id.

list_all_codefresh_boards_names

Get a Codefresh board by name. Returns the board object including _id, name, type, accountId, and filter. Required: name.

create_a_codefresh_boards_section

Create a new Helm board section in Codefresh. Returns the created section object with _id, accountId, boardId, name, color, index, section, and type (Helm). Requires a JSON body; accepts boardId, color, index, name, and section.

get_single_codefresh_boards_section_by_id

Get a Helm board section by id in Codefresh. Returns the section record including _id, accountId, name, type, and filter. Required: id.

update_a_codefresh_boards_section_by_id

Update a Helm board section by id in Codefresh via PUT. Returns the updated section object including _id, accountId, name, boardId, color, index, section, and type. Required: id.

delete_a_codefresh_boards_section_by_id

Delete a Helm board section by id in Codefresh. Returns the deleted section object with _id, accountId, boardId, name, color, index, section, and type. Required: id.

codefresh_boards_sections_bulk_update

Partially update a Helm board section in Codefresh via PATCH. Returns the updated section object including _id, accountId, name, boardId, color, index, section, and type. Required: section_id.

create_a_codefresh_sections_reorder

Reorder Helm board sections in Codefresh by sending a JSON map that assigns each section ID its new position index. Returns a JSON object confirming the reorder.

get_single_codefresh_sections_helm_board_pipelines_config_by_id

Get the board pipelines config for a Codefresh Helm board section. Returns the stored config record including its id and free-form config attributes. Required: id.

create_a_codefresh_sections_helm_board_pipelines_config

Store the board pipelines config for a Codefresh Helm board section. Takes a free-form JSON config object as the body and returns the stored record including its id and config attributes. Required: helm_board_pipelines_config_id.

list_all_codefresh_board_sections

List the sections of a Codefresh Helm board. Returns section objects with _id, name, type, color, index, and boardId. Required: board_id.

codefresh_board_sections_bulk_delete

Delete all sections of a Codefresh Helm board by board id. Returns the deletion result: n (number of sections removed) and ok. Required: board_id.

list_all_codefresh_sections_names

Get a Helm board section in Codefresh by its name. Returns the section object including _id, name, type, filter, and accountId. Required: board_id, name.

list_all_codefresh_helm_repos

List Helm repositories in Codefresh, optionally filtered by a search query. Returns a JSON object response; the upstream API does not document its field-level structure.

create_a_codefresh_helm_repo

Create a Helm repository in Codefresh. Requires a JSON request body, which the upstream API documents as a free-form object without field-level detail. Returns a JSON object response.

get_single_codefresh_helm_repo_by_id

Get a single Helm repository by name in Codefresh. Returns a JSON object response; the upstream API does not document its field-level structure. Required: name.

codefresh_helm_repos_bulk_update

Update a Helm repository by name in Codefresh. Requires name and a JSON request body, which the upstream API documents as a free-form object without field-level detail. Returns a JSON object response. Required: name.

codefresh_helm_repos_bulk_delete

Delete a Helm repository by name in Codefresh. Returns a JSON object response; the upstream API does not document its field-level structure. Required: name.

list_all_codefresh_helm_cluster_configs

Get the helm cluster configuration for a cluster in Codefresh by its selector. Returns: helmVersion, testReleasePipeline, rollbackPipeline, deleteReleasePipeline, allNamespaces, tillerNamespace, releaseNamespaces. Required: selector.

create_a_codefresh_helm_cluster_config

Store the helm cluster configuration used to retrieve helm data from a cluster in Codefresh, identified by its selector. Returns the stored configuration: helmVersion, allNamespaces, tillerNamespace, releaseNamespaces. Required: selector.

list_all_codefresh_helm_release_configs

Get the Helm release config for a specific release in Codefresh. Returns the release config as a JSON object with upstream-defined fields. Required: release_name, selector.

create_a_codefresh_helm_release_config

Store the Helm release config for a specific release in Codefresh. Returns the stored release config as a JSON object with upstream-defined fields. Required: release_name, selector.

create_a_codefresh_releases_refresh

Refresh Helm releases in Codefresh, prompting the platform to re-read Helm release data from its connected clusters. Accepts a free-form JSON object request body and returns an unspecified JSON object response.

create_a_codefresh_releases_force_refresh

Force refresh helm releases in Codefresh. Returns a JSON object response whose fields the upstream spec does not enumerate. No required parameters.

list_all_codefresh_hermes_events

List Codefresh trigger-events, optionally filtered by type, kind, filter, and public. Returns event-trigger records including endpoint, uri, description, status, help, type, kind, account, and secret. See /event/types for available trigger types.

create_a_codefresh_hermes_event

Create a Codefresh trigger-event that provides a webhook endpoint for triggering a pipeline workflow. Returns the created event's uri identifier (e.g. registry:dockerhub:myaccount:hello:push:c2311e92660d).generate to auto-generate).

get_single_codefresh_hermes_event_by_id

Get a Codefresh trigger-event by its event uri identifier. Returns the event record including endpoint, uri, description, status, help, type, kind, account, and secret. Required: event.

codefresh_hermes_events_bulk_delete

Delete a Codefresh trigger-event by its event identifier and account context. Returns an empty string on success; fails with an error if the event is not found. Required: event, context.

list_all_codefresh_hermes_triggers

List Codefresh hermes triggers configured across pipelines. Returns: event, pipeline, filters, event-data.

create_a_codefresh_hermes_trigger

Create a new Codefresh hermes trigger binding an event to a pipeline. Returns the created trigger record with event, pipeline, filters, and event-data. Note: the event value must be URL-encoded twice. Required: event, pipeline.

codefresh_hermes_triggers_bulk_delete

Delete a Codefresh hermes trigger from a pipeline. Returns a trigger record with event, pipeline, filters, and event-data. Note: the event value must be URL-encoded twice. Required: event, pipeline.

list_all_codefresh_triggers_events

List Codefresh triggers matching a specific event name. Returns matching trigger records including event, pipeline, filters, and event-data (event metadata fields may come back empty for this request). Required: event.

list_all_codefresh_triggers_pipelines

List the triggers configured for a Codefresh pipeline by its id. Returns each trigger's event, pipeline, filters, and event-data. Required: pipeline.

list_all_codefresh_hermes_types

List all existing Codefresh trigger types. Returns each trigger type's type, kind, uri-template, help-url, config, and filters.

get_single_codefresh_hermes_type_by_id

Get a specific Codefresh trigger type by type and kind. Returns: type, service-url, kind, uri-template, uri-regex, help-url, config, filters. Required: type, kind.

list_all_codefresh_images

List Codefresh images in the account. Returns: id, hash, created, status, imageName, branch, sha, commit, commitURL, user, account, dockerFile, tags, service, imageDisplayName, internalImageId, size, info, internalName, _id, repo.

get_single_codefresh_image_by_id

Get a single Codefresh image by id. Returns detailed image info including id, hash, status, imageName, branch, commit, commitURL, dockerFile, user, and tags. Required: id.

codefresh_images_tags

List the tags attached to a Codefresh image. Returns the tag data for the image as a JSON object. Required: image_id.

create_a_codefresh_images_external

Add a Codefresh image from an external registry source. Returns the created image object including _id, imageName, status, hash, created, branch, provider, and size. Body accepts Id, Digest, and Image.

create_a_codefresh_image_promote

Promote an image in Codefresh. Returns the promoted image record including _id, imageName, branch, sha, status, and provider. Required: image_id.

create_a_codefresh_image_tag

Tag a Codefresh image by adding tag_name to the image identified by image_id. Returns the updated image record including _id, status, imageName, tags, and created. Required: image_id, tag_name.

codefresh_image_tags_bulk_delete

Untag a Codefresh image by removing tag_name from the image identified by image_id. Returns the updated image record including _id, status, imageName, tags, and created. Required: tag_name, image_id.

get_single_codefresh_metadatum_by_id

Get the metadata of a Codefresh docker image. Returns the metadata as a free-form key/value object whose keys and value types are user-defined. Required: id.

create_a_codefresh_metadatum

Create or update (upsert) metadata for a Codefresh docker image. Returns the metadata as a free-form key/value object whose keys and value types are user-defined. Required: docker_image_id.

codefresh_metadata_bulk_delete

Delete a single metadata key from a Codefresh docker image. Returns the metadata as a free-form key/value object whose keys and value types are user-defined. Required: docker_image_id, key_name.

create_a_codefresh_idp_account

Create an identity provider (IDP) account configuration in Codefresh. Returns the created IDP record as a JSON object, including _id, clientName, clientType, displayName, accounts, and customerId.

codefresh_idp_accounts_bulk_update

Update an existing identity provider (IDP) configuration in Codefresh, identified by the _id supplied in the body. Returns the updated IDP record as a JSON object, including _id, clientName, clientType, displayName, accounts, and customerId.

codefresh_idp_accounts_bulk_delete

Delete an identity provider (IDP) configuration in Codefresh, identified by the _id supplied in the body. Returns a JSON object response including _id, clientName, and displayName.

create_a_codefresh_idp_customer

Create the IDP (identity provider) configuration for a Codefresh customer. Returns the created IDP record including _id, displayName, clientName, clientType, accounts, and customerId. Required: customer_id.

update_a_codefresh_idp_customer_by_id

Update the IDP (identity provider) configuration of a Codefresh customer by id. Returns the updated IDP record including _id, displayName, clientName, clientType, accounts, and customerId. Required: id.

delete_a_codefresh_idp_customer_by_id

Delete the IDP (identity provider) configuration of a Codefresh customer by id. Returns: _id. Required: id.

create_a_codefresh_add_account

Add accounts to a customer's IDP configuration in Codefresh. Returns a JSON object whose fields the API spec does not enumerate. Required: customer_id.

codefresh_delete_accounts_bulk_delete

Remove the accounts attached to a customer's identity provider (IdP) configuration in Codefresh. Returns a 200 JSON response whose payload shape is not documented upstream (no response fields are enumerated in the source). Required: customer_id.

list_all_codefresh_kubernetes_nodes

List the nodes of a Kubernetes cluster in Codefresh. Returns the cluster nodes as a JSON object; the upstream API does not enumerate the response fields. Required: selector.

list_all_codefresh_release_services

Get the Kubernetes services for a Helm release in Codefresh. Returns a JSON object whose fields are not documented upstream. Required: selector, release.

create_a_codefresh_kubernetes_test

Test the Kubernetes cluster credentials configured in Codefresh. Returns an opaque JSON result object; the upstream spec documents no response fields.

list_all_codefresh_kubernetes_services

List Kubernetes services in Codefresh clusters matching a cluster selector. Returns the matching services collection as a JSON object. Required: selector.

list_all_codefresh_kubernetes_namespaces

List the Kubernetes namespaces of the Codefresh clusters matching a cluster selector. Returns a JSON object describing the namespaces available on each matched cluster. Required: selector.

list_all_codefresh_kubernetes_pod_groups

List Kubernetes pod groups in Codefresh. Returns a JSON object whose fields the upstream API does not document. Takes no query parameters.

list_all_codefresh_kubernetes_deployments

Get details of a specific Kubernetes deployment in Codefresh by deployment name. Returns the deployment record including its id and an attributes object with the upstream-defined deployment fields. Required: name.

list_all_codefresh_kubernetes_releases

List Codefresh Helm releases deployed on a cluster. Returns per-release: name, chart, chartVersion, status, namespace, version, and tillerNamespace. Required: selector.

delete_a_codefresh_release_delete_by_id

Delete a Helm release in Codefresh by release name. Returns a JSON object confirmation whose fields are not enumerated upstream. Required: release_name, selector, tiller_namespace.

create_a_codefresh_release_test

Run a test for a Helm release in Codefresh. Returns an untyped JSON object; the upstream spec documents no specific response fields. Required: release_name.

list_all_codefresh_k_8_s_charts

Get the Helm chart data for a release on a cluster in Codefresh. Returns an untyped JSON object whose fields are not documented upstream. Required: selector, name, version.

list_all_codefresh_releases_without_secrets

List Helm releases for a cluster in Codefresh without their secret data. Returns the release object including its name, namespace, chart, chartVersion, status, and createdAt. Required: selector.

list_all_codefresh_charts

Get the Helm chart details for a Codefresh Kubernetes release at a specific revision. Returns the chart information as a JSON object. Required: release_name, revision.

list_all_codefresh_values

Get the Helm chart values for a specific release revision in Codefresh. Returns the values as a dynamic JSON object whose keys are chart-specific and depend on the chart's values.yaml. Required: release_name, revision.

create_a_codefresh_secrets_image_pull_secret

Generate an image pull secret in Codefresh for the clusters matched by the selector and the given namespace. Returns the generated secret as a JSON object; the upstream spec does not enumerate its fields. Required: namespace, selector.

create_a_codefresh_install_helm_3

Install a Helm 3 chart in Codefresh, triggering a pipeline to install the Helm release. Returns the id of the running pipeline. Required: selector.

create_a_codefresh_chart_install

Install a Helm chart in Codefresh by triggering the pipeline that installs the Helm release. Returns: id. Required: selector, tiller_namespace.

create_a_codefresh_promote_helm_3

Create a Helm 3 chart promotion in Codefresh, triggering the promote pipeline for a Helm release with the target namespace, release names, revision, values, and set overrides you specify. Returns: id.

create_a_codefresh_chart_promote

Promote a Helm chart release (Tiller-based) in Codefresh. Returns a JSON object; the API spec does not enumerate its fields. Sends a free-form JSON object body; selector is an optional query filter. Required: tiller_namespace.

list_all_codefresh_kubernetes_rollbacks

Roll back a Kubernetes Helm release in Codefresh to a specific Helm revision. Returns the id of the pipeline that performed the rollback. Required: release, revision, tiller_namespace.

list_all_codefresh_rollback_builds

List the builds for a Kubernetes release rollback in Codefresh, identified by selector and release. Returns build records with id, status, created, finished, pipelineName, and steps. Required: selector, release.

list_all_codefresh_kubernetes_s

Send a GET request through the Codefresh Kubernetes proxy to the Kubernetes API of the target cluster. Returns the raw JSON object returned by the Kubernetes endpoint; its fields depend entirely on the proxied sub-path and query.

create_a_codefresh_kubernetes

Send a POST request through the Codefresh Kubernetes proxy to the Kubernetes API of the target cluster; the JSON request body is forwarded as-is. Returns the raw JSON object returned by the Kubernetes endpoint; its fields depend entirely on the proxied operation.

codefresh_kubernetes_s_bulk_update

Update a Kubernetes resource through the Codefresh proxy, sending a JSON body that is forwarded verbatim to the upstream Kubernetes API. Returns the upstream Kubernetes API's JSON response as a generic object; the response fields are not enumerated in the source API spec.

codefresh_kubernetes_s_bulk_delete

Delete a Kubernetes resource through the Codefresh proxy, forwarding the request to the upstream Kubernetes API. Returns the upstream Kubernetes API's JSON response as a generic object; the response fields are not enumerated in the source API spec.

list_all_codefresh_pipelines

List Codefresh pipelines in the account, with optional filters such as project, labels, or execution context. Returns each pipeline's metadata (name, project, projectId, revision, id), version, kind, spec (triggers, cronTriggers, steps, stages, variables), and last_executed timestamp.

create_a_codefresh_pipeline

Create a new pipeline in the Codefresh account from a Codefresh YAML-style definition; use update to modify existing pipelines. Returns the created pipeline's metadata (name, project, projectId, revision, id), version, kind, and spec (triggers, cronTriggers, steps, stages, variables).

get_single_codefresh_pipeline_by_id

Get a Codefresh pipeline by name or id (escape slashes in names, e.g. simple%2FnewOne). Returns: metadata, spec, version, kind, last_executed, name, in, schema. Required: name.

codefresh_pipelines_bulk_update

Replace a Codefresh pipeline identified by name or id. Send a modified copy of the get response as the payload, since the pipeline revision is checked. Returns: metadata, spec, version, kind, last_executed, name, in, schema. Required: name.

codefresh_pipelines_bulk_delete

Delete a Codefresh pipeline by name or id. Returns the deleted pipeline's metadata (name, project, projectId, revision, id), version, kind, and spec. Required: name.

list_all_codefresh_pipelines_invalid_triggers

List all incorrectly configured pipeline triggers in Codefresh. Returns, for each misconfigured trigger: id, name, context, provider, repo, and pipelineName.

codefresh_pipelines_invalid_triggers_bulk_update

Resolve all incorrectly configured triggers for the account's pipelines in Codefresh. Returns: failed, succeed. Takes no parameters.

list_all_codefresh_pipelines_triggers

List all pipeline triggers in Codefresh for the account. Returns: id, name, context, provider, repo, pipelineName.

create_a_codefresh_pipelines_template

Create a new Codefresh pipeline template from an existing pipeline, identified by its id or escaped full name (e.g. 6025136a42e51b441eb9b1c8 or project%2FtemplateName). Returns the created template including metadata (id, name, project, created_at), spec (steps, triggers, variables), version, and kind. Required: name.

list_all_codefresh_pipelines_templates

List the Codefresh pipeline templates available in the account. Returns a collection of pipeline records each including metadata (id, name, project, created_at), spec (steps, triggers, variables), version, and kind.

create_a_codefresh_template_set_as_template

Set a Codefresh pipeline as a template, identified by its escaped name (projectName%2fname) or pipeline id. Returns the templated pipeline object with metadata (name, id, project, template.isTemplate), spec (triggers, steps, variables, contexts), version, kind, and last_executed. To un-template, the pipeline must be updated and replaced. Required: name.

list_all_codefresh_pipelines_exists

Check whether at least one pipeline exists in the Codefresh account. Returns a boolean value — true when the account has at least one pipeline. This internal endpoint takes no parameters.

list_all_codefresh_pipelines_labels

List the pipeline label keys defined on pipelines in Codefresh. Returns an array of label key strings, typically empty or containing keys such as "tags". Takes no parameters.

list_all_codefresh_pipelines_names

List pipelines in the Codefresh account, returning an array of pipeline records. Returns: metadata, version, kind, spec, last_executed.

list_all_codefresh_utils_extract_variables

Extract the variables declared in a Codefresh pipeline YAML, which is fetched from the remote URL supplied via yamlURL. Returns a JSON object of the extracted variables whose exact shape depends on the contents of the supplied YAML, so fields vary by pipeline.

create_a_codefresh_pipelines_run

Run a Codefresh pipeline to start a new build, or restart a previous build by passing its id in previousWorkflow. Returns the new build ID (e.g. 602d10fdbfbd9b04e58e3ed0).

create_a_codefresh_pipelines_debug

Run a Codefresh pipeline in debug mode and retrieve the id of the created pipeline. Returns: id. Required: name.

create_a_codefresh_yaml_validator

Validate Codefresh pipeline YAML by posting it to this utility endpoint. Returns a JSON object with the validation result — the upstream spec documents it only as an untyped JSON object and does not enumerate its fields. Requires a JSON body; its field names are not documented upstream.

list_all_codefresh_yaml_test_urls

Test pipeline YAML loaded from a URL in Codefresh. An internal endpoint that returns an opaque JSON object whose fields are not documented upstream.

list_all_codefresh_templates_deploy_images

Get the deploy images for Codefresh pipeline templates. This is an internal endpoint. Returns: _id, hash, created, status, imageName, branch, sha, commit, commitURL, buildDetails, systemInvalid, user, account, dockerFile, provider, tags, service, imageDisplayName, internalImageId, size, info, internalName, __v.

codefresh_clone_variables_bulk_update

Clone variables from an origin pipeline onto a target pipeline in Codefresh. Returns the clone result as a JSON object; the upstream API does not document its fields. Internal Codefresh endpoint. Required: name, origin_pipeline_name.

list_all_codefresh_projects_alls

List all projects referenced by Codefresh pipelines. Returns a JSON object whose fields the upstream API does not document. This is an internal Codefresh endpoint and takes no parameters.

list_all_codefresh_pipeline_project_vars

Get the project variables of a Codefresh pipeline, identified by its name or id. Returns: key, value, encrypted. Required: name.

codefresh_pipeline_execution_contexts_bulk_update

Assign a pipeline execution context to a Codefresh pipeline by name. Returns the updated pipeline including metadata, spec (triggers, variables, steps, contexts), kind, and version. Required: name.

codefresh_pipeline_execution_contexts_bulk_delete

Unassign the execution context from a Codefresh pipeline by name. Returns the updated pipeline including metadata, spec (triggers, variables, steps, contexts), kind, and version. Required: name.

list_all_codefresh_pipeline_preview_run_inputs

Get a preview of the run input (variables and options) for a Codefresh pipeline execution. Returns the input preview including variables and options. Required: name, trigger.

codefresh_pipeline_triggers_verify

Verify a pipeline trigger in Codefresh. Returns a JSON verification result whose fields the upstream API does not document (opaque object). The upstream API marks this endpoint as internal. Required: name, trigger_id.

list_all_codefresh_pipeline_extract_variables

Extract variables from a Codefresh pipeline YAML. Returns an untyped JSON object whose contents depend on the variables defined in the fetched YAML. Required: yaml_u_r_l, name.

list_all_codefresh_pipeline_volume_images

Get the volume image configuration for a Codefresh pipeline identified by name. Returns the volume image object as a generic JSON object; the upstream internal endpoint does not enumerate its response fields. Required: name.

list_all_codefresh_views

List Codefresh views. Returns each view with its id and an attributes object whose fields depend on the view's type.

create_a_codefresh_view

Create a new view in Codefresh by posting its JSON definition. Returns the created view with its id and view-type-specific attributes.

get_single_codefresh_view_by_id

Get a single Codefresh view by name. Returns the view with its id and view-type-specific attributes. Required: name.

codefresh_views_bulk_update

Replace an existing Codefresh view by name, sending the replacement view definition as the JSON body. Returns the updated view with its id and view-type-specific attributes. Required: name.

codefresh_views_bulk_delete

Delete a Codefresh view by name. Returns a 200 JSON response (id, view-type-specific attributes). Required: name.

list_all_codefresh_views_tags

List the tags used across a Codefresh account's views. Returns a JSON object whose field set the upstream API spec does not document.

list_all_codefresh_types_metadata

List the metadata for all event types supported by Codefresh, describing how each trigger type's configuration fields and filters are defined. Returns for each type: type, kind, uri-template, uri-regex, help-url, config field definitions, and filters.

list_all_codefresh_types_names

List the available view type names in Codefresh. Requires no parameters. Returns a JSON object of view type names; the upstream API does not enumerate the response fields.

list_all_codefresh_type_fields

List the field definitions for a Codefresh trigger type. Returns the trigger type definition including type, kind, uri-template, config argument fields (name, type, help, validator, required) and filter fields. Required: type.

list_all_codefresh_step_types

List Codefresh step-types. Returns each step-type record with kind, metadata, and spec.

create_a_codefresh_step_type

Create a Codefresh step-type by posting a definition body with kind, metadata.name, and spec. Returns the created step-type record with kind, metadata, and spec.

get_single_codefresh_step_type_by_id

Get a single Codefresh step-type by name. Returns the step-type record with kind, metadata, and spec. Required: name.

codefresh_step_types_bulk_update

Replace an existing Codefresh step-type identified by name with a new definition body containing kind, metadata, and spec. Returns the updated record with kind, metadata, and spec. Required: name.

codefresh_step_types_bulk_delete

Delete a Codefresh step-type by name. Returns the deleted step-type record with kind, metadata, and spec. Required: name.

list_all_codefresh_step_type_versions

List the available versions of a step type in Codefresh. Returns the step type's version data as a JSON object whose fields depend on the step type's definition. Required: name.

list_all_codefresh_gitops_filters

Get the available application filter values for GitOps (Argo CD) applications in Codefresh, used to populate Environment Dashboard filters. Returns an aggregation object whose field-level shape the API does not document. Takes no parameters.

list_all_codefresh_environments_v_2_s

List environments in Codefresh. Returns a collection of environment records, each including kind, metadata, and spec.

create_a_codefresh_environments_v_2

Create a new environment in Codefresh. Returns the created environment record including kind, metadata, and spec.

get_single_codefresh_environments_v_2_by_id

Get a Codefresh environment by name. Returns the environment record including kind, metadata, and spec. Required: name.

codefresh_environments_v_2_s_bulk_update

Replace an existing Codefresh environment identified by name. Returns the updated environment record including kind, metadata, and spec. Required: name.

codefresh_environments_v_2_s_bulk_delete

Delete a Codefresh environment by name. Returns: kind, metadata, spec. Required: name.

get_single_codefresh_environments_v_2_activity_by_id

Get the list of environments associated with a specific activity in Codefresh Environments V2. Returns a JSON object whose fields are not enumerated in the upstream spec. Required: id.

codefresh_environments_v_2_activities_bulk_update

Update a Codefresh Environments V2 activity by name within a specific environment. Returns a JSON object whose fields are not enumerated in the upstream spec; the request body is a free-form JSON object. Required: environment_name, activity_name.

list_all_codefresh_kubernetes_statistics

Get the Kubernetes summary statistics for a Codefresh environment by name. Returns a JSON summary object whose field structure is not enumerated in the API documentation. Required: name.

create_a_codefresh_argo_metadatum

Update Argo CD activity metadata in Codefresh environments-v2 by posting a JSON metadata object. Returns a free-form JSON object whose fields are not enumerated in the API reference. No required parameters beyond the metadata request body.

codefresh_environments_v_2_updates_bulk_update

Patch an existing environment in Codefresh by name. Returns the updated environment object including kind, metadata (with its name), and spec. Required: name.

create_a_codefresh_reset_new

Reset an environment in Codefresh by creating a replacement for the existing environment identified by name, submitting its manifest. Returns the environment object with its kind, metadata (including name), and spec. Required: name.

list_all_codefresh_environments_v_2_charts

Get the Argo chart for a Codefresh environment over a date range. Returns: date, rollouts. Required: name, start_date, end_date.

create_a_codefresh_environments_v_2_rollback

Trigger a rollback of a Codefresh Argo CD environment to a previous rollout deployment. Returns an opaque JSON object on success; the Codefresh API does not document the response fields for this endpoint. Required: name.

list_all_codefresh_gitops_applications

List Codefresh GitOps (Argo) applications, optionally narrowed to a single id or name. Returns each application's kind, metadata (including name), and spec.

create_a_codefresh_gitops_application

Create a Codefresh GitOps (Argo) application from a manifest payload. Returns the created application with kind, metadata (including name), and spec.

codefresh_gitops_applications_bulk_update

Replace a Codefresh GitOps (Argo) application, identified by its application name. Returns the replaced application manifest with kind, metadata (name), and spec. Required: name.

codefresh_gitops_applications_bulk_delete

Delete a Codefresh GitOps (Argo) application by its application name. Returns: kind, metadata (name), and spec. Required: name.

codefresh_updates_bulk_update

Replace a GitOps (Argo CD) application manifest in Codefresh by application name. Returns the replaced application object: kind, metadata, spec. Required: name.

create_a_codefresh_rollback_to_stable

Roll back an Argo CD environment in Codefresh to its stable version. Returns the rollback response as a JSON object. Required: name.

list_all_codefresh_environments_v_2_filters

Get the filter values for a Codefresh environment by name. Returns a JSON object of filter values whose fields are not enumerated upstream. Required: name.

list_all_codefresh_all_tags

List all tags in use across GitOps (Argo CD) applications in Codefresh. The response is an untyped JSON object whose field structure is not documented upstream, so treat the payload as opaque. Takes no parameters.

create_a_codefresh_set_tag

Set the tags for an environment (GitOps application) in Codefresh. Returns a 200 JSON object response; the upstream API does not document its field shape. Required: name.

create_a_codefresh_argo_provision

Provision Argo applications in Codefresh via the Environments V2 API. Accepts a JSON request body and returns the provisioning result as a JSON object; the upstream API does not enumerate its field structure.

list_all_codefresh_argos

List Argo CD integrations configured in Codefresh. Returns the integrations as a JSON object; the upstream docs do not enumerate its fields. No required parameters.

create_a_codefresh_argo

Create a new Argo CD integration in Codefresh. Returns the created integration record as a JSON object; the upstream docs do not enumerate its fields. Requires a JSON request body.

codefresh_argos_bulk_update

Update an existing Argo CD integration by name in the Codefresh Environment Dashboard. Returns the updated integration record including name and provider-specific attributes. Required: name.

codefresh_argos_bulk_delete

Delete an Argo CD integration by name from the Codefresh Environment Dashboard. Returns the deleted integration record including name and provider-specific attributes. Required: name.

list_all_codefresh_argo_resources

List Argo resources in Codefresh by environments-v2 integration name and resource type. Returns the matching resources as a JSON object whose fields are specific to the requested resource type. Required: integration_name, type.

create_a_codefresh_argo_agent

Store Argo state for a Codefresh integration identified by its name. Returns a JSON object acknowledging the stored state; the upstream spec does not enumerate its fields. Required: integration_name.

create_a_codefresh_system_event

Send a system event about GitOps to Codefresh. Returns a JSON object response; the upstream API documents both the request body and the response as generic JSON objects without enumerating their fields.

list_all_codefresh_resources

List resources for a GitOps environment in Codefresh, as shown in the environment's activity. Returns a single JSON object of resource data; the upstream API documents the response only as a JSON object without field-level detail. Required: environment_id.

create_a_codefresh_argo_agent_heartbeat

Send a heartbeat for an Argo CD integration in Codefresh to mark it as active. Returns a JSON object response; the upstream API does not enumerate its fields. Required: integration_name.

create_a_codefresh_argo_runtime

Create a new Argo runtime in Codefresh. Returns the created Argo runtime object as a JSON object; the upstream API does not document its field structure. The request accepts a JSON configuration object.

codefresh_argo_runtimes_bulk_delete

Delete an Argo runtime in Codefresh by name. Returns a JSON object on success; the upstream API does not document its fields. Required: name.

list_all_codefresh_argo_runtime_store_keys

Get the public store key for a Codefresh Argo runtime by runtime name. Returns the store key as an opaque JSON object; the upstream docs do not enumerate its fields. Required: name.

list_all_codefresh_argo_runtime_users

List the users defined on the active Codefresh account. Returns a JSON object of the account's users; the upstream API documentation describes this response only as a generic object and does not enumerate its fields. No caller-supplied parameters are required.

list_all_codefresh_argo_runtime_admin_users

Get the admin users defined on the active Codefresh account. Returns a JSON object of admin users; the upstream API does not document the object's field-level structure. Requires no parameters.

create_a_codefresh_argo_runtime_csdp_setting

Update the Codefresh Argo runtime CSDP settings (Git provider, Git API URL, shared configuration repository). Returns a JSON object with the updated settings; the API does not further specify its fields. Settings already marked as validated block further updates.

create_a_codefresh_argo_runtime_mark_csdp_settings_as_validated

Mark the Codefresh CSDP settings (gitProvider, gitApiUrl, sharedConfigRepo) as validated, which blocks future updates to these settings. Returns a 200 JSON object whose fields are not documented upstream.

list_all_codefresh_projects

List Codefresh projects. Returns: accountId, projectName, updatedAt, metadata, image, tags, variables, pipelinesNumber, id, favorite.createdAt.

create_a_codefresh_project

Create a new Codefresh project with a name, tags, and key/value variables. Returns the created project including its id, projectName, accountId, tags, variables, updatedAt, and metadata.createdAt.

get_single_codefresh_project_by_id

Get a single Codefresh project by id. Returns: accountId, projectName, updatedAt, metadata, image, tags, variables, pipelinesNumber, id, favorite.createdAt. Required: id.

update_a_codefresh_project_by_id

Update an existing Codefresh project by id, accepting a new projectName and/or tags. Returns the updated project including accountId, projectName, tags, updatedAt, metadata.createdAt, variables, and id. Required: id.

delete_a_codefresh_project_by_id

Delete a Codefresh project by id. Returns an empty 204 response on success. Required: id.

list_all_codefresh_projects_tags

List Codefresh project tags. Returns an array of tag name strings, optionally filtered by a regular expression via tagsNameRegex.

list_all_codefresh_projects_names

Get a Codefresh project by name. Returns the project object including its id, projectName, accountId, tags, variables, pipelinesNumber, favorite, and updatedAt. Required: name.

get_single_codefresh_progress_download_by_id

Download a progress report from Codefresh by id. Returns the downloaded JSON object with content-type-specific fields defined upstream. Required: id.

list_all_codefresh_services

Download the services logs for a Codefresh progress download job. Returns an opaque JSON object; the upstream API does not document its fields. Required: download_id.

create_a_codefresh_service

Create a new service in Codefresh for a git repository via serviceDetails (name, scm.name, scm.owner.name). Returns an opaque JSON object; the upstream API does not document its fields. The upstream spec marks this operation deprecated.

get_single_codefresh_service_by_id

Get a single Codefresh service by name. Returns an opaque JSON object; the upstream API does not document its fields. Required: name.

codefresh_services_bulk_delete

Delete a Codefresh service by name. Returns an opaque JSON object; the upstream API does not document its fields. Required: name.

get_single_codefresh_progrese_by_id

Get a build's progress object in Codefresh by id. Returns the progress object as JSON including its id. Required: id.

delete_a_codefresh_progrese_by_id

Terminate a running build in Codefresh by its progress id. Returns the progress object as JSON including its id. Required: id.

create_a_codefresh_github_hook

Send a GitHub webhook event to Codefresh for the hook identified by hook_id, triggering any pipelines bound to that hook trigger. Returns an opaque JSON acknowledgement whose fields depend on the GitHub event. Required: hook_id.

create_a_codefresh_gitlab_hook

Send a GitLab webhook event to Codefresh, forwarding it to the hook identified by hook_id. Returns a JSON acknowledgment of the forwarded event; its fields are event-specific and not fixed by the API. Required: hook_id.

create_a_codefresh_bitbucket_hook

Send a Bitbucket webhook event to Codefresh's webhook receiver. Returns an opaque JSON acknowledgement object; the response shape is not enumerated upstream. Required: hook_id.

create_a_codefresh_bitbucket_server_hook

Send a Bitbucket Server webhook event to Codefresh through the hook endpoint identified by hook_id. Returns an opaque JSON acknowledgement whose body shape is not documented upstream. Required: hook_id.

create_a_codefresh_azure_devops_hook

Send an Azure DevOps webhook through the Codefresh providers endpoint for the hook identified by its id. Returns an untyped JSON object from the webhook forward. Required: hook_id.

create_a_codefresh_gerrit_hook

Send a gerrit webhook event to Codefresh for the hook identified by hook_id. This webhook-receive endpoint needs no request body and returns an opaque JSON acknowledgement with no documented fields. Required: hook_id.

create_a_codefresh_auth_token

Generate a new CFCR registry auth token in Codefresh. Returns the token itself as a plain-text string (the response body is the raw token). The request body takes name to describe the new token.

delete_a_codefresh_auth_token_by_id

Delete a CFCR registry auth token from a Codefresh container registry by id. Returns the plain-text confirmation 'Ok' on success. Required: id.

list_all_codefresh_repos

List git repositories connected to Codefresh through its GitHub, Bitbucket, and other git integrations. Returns: _id, id, provider, features, name, private, pushed_at, open_issues, clone_url, ssh_url, owner, org, default_branch, permissions, context.

list_all_codefresh_repos_refreshes

Get info about the last refresh of the cached Git repo list for a behind-the-firewall Git context in Codefresh. Returns a JSON object describing the last refresh; the upstream API documents the body only as JSON and does not enumerate its fields.

create_a_codefresh_repos_refresh

Refresh the list of cached Git repos for a behind-the-firewall Git context in Codefresh. Returns a JSON object describing the refresh; the upstream API documents the body only as JSON and does not enumerate its fields.

list_all_codefresh_registries

List the container registries connected to the Codefresh account. Returns each registry's _id, name, provider, kind, domain, and provider-specific fields such as region or username.

create_a_codefresh_registry

Create a container registry in Codefresh for one of the supported providers (ecr, dockerhub, gcr, bintray, other). Returns the created registry including _id, name, provider, kind, and domain. Credential fields vary by provider (e.g. region for ecr; username and password for dockerhub).

update_a_codefresh_registry_by_id

Update an existing container registry in Codefresh by id with an updated registry object. Returns the updated registry including _id, name, provider, kind, and domain. Credential fields vary by provider (e.g. region for ecr; username and password for dockerhub). Required: id.

delete_a_codefresh_registry_by_id

Delete a container registry from Codefresh by id. Returns the id of the deleted registry. Required: id.

codefresh_registries_bulk_update

Set a container registry in Codefresh as the account's default registry. Returns a plain-text success body ("true") rather than a registry object. Required: registry_id.

codefresh_registrie_primaries_bulk_update

Set a registry as the primary registry in Codefresh. Returns the confirmation string `true` on success. Required: registry_id.

codefresh_registrie_internals_bulk_update

Set a Codefresh registry as internal by id. Returns the literal string 'true' (text/html) on success. Required: registry_id.

create_a_codefresh_registries_test

Test a container registry connection in Codefresh by validating the provided registry configuration and credentials against the upstream registry. Requires name and provider; provider-specific credentials are also conditionally required (e.g. region for ecr, keyFile for gcr, token and domain for bintray, password and domain for other). Returns a generic JSON result object; the upstream API does…

list_all_codefresh_repos_existings

List existing git repositories in Codefresh via the repos/existing endpoint. Returns a JSON object whose internal field structure is not documented upstream, so treat the payload shape as unspecified. No parameters are required.

list_all_codefresh_repos_settings

Get the settings Codefresh holds for a specific git repository. Returns the repo settings as a generic JSON object; the upstream API does not enumerate the settings fields. Required: repo_owner, repo_name.

list_all_codefresh_runtime_environments

List Codefresh runtime environments that pipelines can run on. Returns runtime environment records including id, name, and description.

get_single_codefresh_runtime_environment_by_id

Get a Codefresh runtime environment by id (its runtime environment name, e.g. my-aws-runner/cf). Returns the record including id, name, and description. Required: id.

delete_a_codefresh_runtime_environment_by_id

Delete a Codefresh runtime environment by id (its runtime environment name). Returns a record including id, name, and description. Required: id.

codefresh_runtime_environments_set_default

Set a Codefresh runtime environment as the account default. Returns a record including id, name, and description. Required: runtime_environment_name.

update_a_codefresh_runtime_environment_by_id

Update a Codefresh runtime environment by id (its runtime environment name). Returns the updated record including id, name, and description. The request body is a free-form JSON object of the attributes to upsert. Required: id.

list_all_codefresh_runtime_environment_base_images

List the base images available for a Codefresh runtime environment. Returns a JSON object of image data whose exact structure the API does not document field-by-field. Required: runtime_environment_name.

list_all_codefresh_teams

List teams in Codefresh. Returns team records including id, name, tags, and users.

create_a_codefresh_team

Create a team in Codefresh with a name, its member users, and tags. Returns the created team record including id, name, tags, and users.

delete_a_codefresh_team_by_id

Delete a Codefresh team by id. Returns an empty 200 response on success. Required: id.

codefresh_teams_find_teams_by_user

List the Codefresh teams a user belongs to. Returns team records including id, name, tags, and users. Required: user_id.

list_all_codefresh_types

Synchronize a Codefresh team group's client by group name and client type. Returns a JSON object whose fields the upstream spec does not enumerate. Required: name, type.

codefresh_assign_user_to_teams_bulk_update

Assign a user to a team in Codefresh by id. Returns a JSON object response; the upstream API documents it as an untyped object and does not enumerate its fields. Required: team_id, user_id.

codefresh_rename_teams_bulk_update

Rename a Codefresh team by supplying its id and the new team name. Returns an empty response on success. Required: team_id.

codefresh_delete_user_from_teams_bulk_update

Remove a user from a Codefresh team by id. Returns a JSON object response on success; the upstream specification does not enumerate its fields. Required: team_id, user_id.

get_single_codefresh_service_user_by_id

Get a Codefresh service account by id together with the teams it belongs to. Returns: id. Required: id.

update_a_codefresh_service_user_by_id

Update a Codefresh service account's userName and team assignments. Returns the updated account with: id, userName, teams. Accepts userName, teamIds, and assignAdminRole. Required: id.

delete_a_codefresh_service_user_by_id

Delete a Codefresh service account by id. Returns: id. Required: id.

list_all_codefresh_service_users

List Codefresh service accounts. Returns each account with: id, userName, teams.

create_a_codefresh_service_user

Create a Codefresh service account. Returns the new account with: id, userName, teams. Accepts userName, teamIds, and assignAdminRole.

create_a_codefresh_service_user_set_status

Enable or disable a Codefresh service account by id. Requires service_user_id (the service account's id) and isDisabled. Returns a JSON response object. Required: service_user_id.

list_all_codefresh_agent_tasks

List pending Codefresh agent tasks. Returns the task fields: type, spec (the task payload), and metadata (including createdAt, account, reName, and workflow). Deprecated: this endpoint is deprecated and was used only by old venona agents to fetch new tasks.

codefresh_agent_status_bulk_update

Update the agent status reported to Codefresh. Used by legacy (venona) agents to report health status, sending a message such as 'All good'. Returns an empty 201 response on success. Deprecated.

list_all_codefresh_tasks

List pending tasks for a Codefresh agent, used by Codefresh Runners to pick up new work. Returns an array of tasks with type, spec payload, and metadata (createdAt, account, workflow). Required: agent_id.

update_a_codefresh_task_status_by_id

Update the status of a Codefresh agent task; used by the Codefresh Runners to report task status. Returns an empty 204 response on success. A status already reported for the same revision is rejected with a conflict. Required: agent_id, task_id.

list_all_codefresh_agents

List all Codefresh agents. Returns each agent's id, name, account, tokenName, attached runtimes, and status (healthStatus, reportedAt).

create_a_codefresh_agent

Create a new Codefresh agent. Returns the created agent with id, name, account, tokenName, attached runtimes, and status. Requires name. Required: name.

update_a_codefresh_agent_by_id

Update a Codefresh agent by id. Returns the updated agent with id, name, account, attached runtimes, and status. Required: id.

delete_a_codefresh_agent_by_id

Delete a Codefresh agent by id. Returns an empty 204 response on success. Required: id.

get_single_codefresh_agent_by_id

Get a single Codefresh agent by id. Returns the agent's id, name, account, tokenName, attached runtimes, and status. Required: id.

list_all_codefresh_agents_names

Get a Codefresh agent by its name. Returns: id, name, account, tokenName, runtimes, status. Required: name.

create_a_codefresh_runner_installation

Create a new Codefresh runner installation progress session. Returns the created progress object including id, createdAt, and updatedAt. Accepts a free-form JSON body; the upstream spec documents no required body fields.

get_single_codefresh_runner_installation_by_id

Get a Codefresh runner installation progress session by id. Returns the progress object including id, createdAt, and updatedAt. Required: id.

update_a_codefresh_runner_installation_by_id

Update a Codefresh runner installation progress session by id, reporting a new installation progress event. Returns the progress object including id, createdAt, and updatedAt. Body is a free-form JSON object. Required: id.

get_single_codefresh_account_api_key_ip_allowlist_by_id

Get the API key IP allowlist for a Codefresh account, including the enforcement switch state and its entries. Returns: enabled (switch state) and entries with id, ip, description, and enabled. Required: id.

create_a_codefresh_account_api_key_ip_allowlist

Add an entry (IP address with optional description) to a Codefresh account's API key IP allowlist. Returns the allowlist including its enabled switch state and entries. Required: account_id.

update_a_codefresh_account_api_key_ip_allowlist_by_id

Update an API key IP allowlist entry (ip, description or enabled/disabled state) for a Codefresh account. Returns the allowlist including its enabled switch state and entries. Required: id, account_id.

delete_a_codefresh_account_api_key_ip_allowlist_by_id

Remove an entry from a Codefresh account's API key IP allowlist. Returns the updated allowlist including its enabled switch state and remaining entries. Required: id, account_id.

codefresh_api_key_ip_allowlist_switches_bulk_update

Turn the Codefresh account API key IP allowlist enforcement on or off via the enabled boolean in the request body; when on, only requests from enabled entries pass, and an empty list blocks all API keys. Returns a JSON object on success. Required: account_id.

create_a_codefresh_api_key_ip_allowlist_validate

Validate an IP address or CIDR range for a Codefresh account's API key IP allowlist. Returns a JSON object with the canonical form the value would be saved as and its coverage against existing entries. Required: account_id.

list_all_codefresh_api_key_ip_allowlist_blocked_requests

List API key requests rejected by the Codefresh account IP allowlist within a time window, grouped by source IP and API key. Returns the aggregated blocked-request data for the window. Required: account_id, from, to.

list_all_codefresh_whereamis

Get the caller's IP address as the Codefresh platform derives it — the same address the API key IP allowlist evaluates. Requires no parameters. Returns an opaque JSON object; the upstream spec documents no field names for this response.

create_a_codefresh_sms_start

Start SMS verification in Codefresh: send a verification code to the provided phone number (the code is then confirmed via the SMS check endpoint). Returns a 201 JSON object whose fields the upstream spec does not enumerate. Requires a JSON body supplying the phone number to text; the upstream docs do not name the exact body fields.

create_a_codefresh_sms_check

Check a provided SMS verification code in Codefresh, completing the verification flow started by sending an SMS code to a phone number. Sends the verification details as a JSON body and returns a 201 JSON response; the upstream API spec does not enumerate the request or response fields.

get_single_codefresh_oidc_id_token_by_id

Get the OIDC ID token for a Codefresh workflow (build) by id. Returns an unstructured JSON token payload whose field shape is not enumerated upstream. Required: id.