accept_invitation_for_team
Accept Team Invitation
Parameters
Accept (required)
Type: string
team-invitation_token (required)
Type: string
accept_pending_peering_connection_with_space
Accept a pending peering connection with a private space.
Parameters
Accept (required)
Type: string
peering_pcx_id (required)
Type: string
space_identity (required)
Type: string
change_plan_for_add_on
Change add-on plan. Some add-ons may not support changing plans. In that case, an error will be returned.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"name" : "globally unique name of the add-on",
"plan" : "unique identifier or name of plan"
}
confirm_sms_number_change
Confirm an SMS number change with a confirmation code
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
create_add_on_attachment
Create a new add-on attachment.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"app" : "unique identifier or name of app",
"confirm" : "name of owning app for confirmation",
"addon" : "unique identifier or name of add-on",
"name" : "unique name for this add-on attachment to this app",
"namespace" : "attachment namespace"
}
create_add_on_for_app
Create a new add-on.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"confirm" : "name of billing entity for confirmation",
"attachment" : {
"name" : "unique name for this add-on attachment to this app"
},
"name" : "globally unique name of the add-on",
"config" : { },
"plan" : "unique identifier or name of plan"
}
create_app
Create a new app.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"stack" : "unique identifier or name of stack",
"name" : "unique name of app",
"region" : "unique identifier or name of region"
}
create_app_in_team
Create a new app in the specified team, in the default team if unspecified, or in personal account, if default team is not set.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"stack" : "unique name of stack",
"internal_routing" : "describes whether a Private Spaces app is externally routable or not",
"name" : "unique name of app",
"personal" : "force creation of the app in the user account even if a default team is set.",
"team" : "unique name of team",
"locked" : "are other team members forbidden from joining this app.",
"region" : "unique name of region",
"space" : "unique name of space"
}
create_app_setup
Create a new app setup from a gzipped tar archive containing an app.json manifest file.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"app" : {
"stack" : "unique name of stack",
"organization" : "unique name of team",
"name" : "unique name of app",
"personal" : "force creation of the app in the user account even if a default team is set.",
"locked" : "are other team members forbidden from joining this app.",
"region" : "unique name of region",
"space" : "unique name of space"
},
"overrides" : {
"buildpacks" : [ {
"url" : "location of the buildpack"
} ],
"env" : { }
},
"source_blob" : {
"checksum" : "an optional checksum of the gzipped tarball for verifying its integrity",
"version" : "Version of the gzipped tarball.",
"url" : "URL of gzipped tarball of source code containing app.json manifest file"
}
}
create_app_transfer_for_account
Create a new app transfer.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"app" : "unique identifier or name of app",
"silent" : "whether to suppress email notification when transferring apps",
"recipient" : "unique identifier, email, or full name of an account"
}
create_build_for_app
Create a new build.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"buildpacks" : [ {
"name" : "Buildpack Registry name of the buildpack for the app",
"url" : "the URL of the buildpack for the app"
} ],
"source_blob" : {
"checksum" : "an optional checksum of the gzipped tarball for verifying its integrity",
"version" : "Version of the gzipped tarball.",
"url" : "URL where gzipped tar archive of source code for build was downloaded."
}
}
create_collaborator_for_team
Create a new collaborator.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"silent" : "whether to suppress email invitation when creating collaborator",
"user" : "unique identifier, email, or full name of an account"
}
create_collaborator_on_app_for_team
Create a new collaborator on a team app. Use this endpoint instead of the /apps/{app_id_or_name}/collaborator
endpoint when you want the collaborator to be granted [permissions] (https:/devcenter.heroku.com/articles/org-users-access#roles-and-permissions) according to their role in the team.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"silent" : "whether to suppress email invitation when creating collaborator",
"permissions" : [ "The name of the app permission." ],
"user" : "unique identifier, email, or full name of an account"
}
create_credit_for_account
Create a new credit.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"code2" : "second code from a discount card",
"code1" : "first code from a discount card"
}
create_domain_for_app
Create a new domain.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"hostname" : "full hostname"
}
create_dyno
Create a new dyno.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"size" : "dyno size (default: \"standard-1X\")",
"time_to_live" : "seconds until dyno expires, after which it will soon be killed, max 86400 seconds (24 hours)",
"attach" : "whether to stream output or not",
"env" : { },
"type" : "type of process",
"command" : "command used to start this process",
"force_no_tty" : "force an attached one-off dyno to not run in a tty"
}
create_identity_provider_for_team
Create an Identity Provider for a team
Parameters
Accept (required)
Type: string
team_name (required)
Type: string
$body
Type: object
{
"certificate" : "raw contents of the public certificate (eg: .crt or .pem file)",
"slo_target_url" : "single log out URL for this identity provider",
"sso_target_url" : "single sign on URL for this identity provider",
"entity_id" : "URL identifier provided by the identity provider"
}
create_inbound_ruleset_in_space
Create a new inbound ruleset
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
$body
Type: object
{
"rules" : [ {
"action" : "states whether the connection is allowed or denied",
"source" : "is the request’s source in CIDR notation"
} ]
}
create_invitation_for_team
Create Team Invitation
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
$body
Type: object
{
"role" : "role in the team",
"email" : "unique email address of account"
}
create_log_drain_for_app
Create a new log drain.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"url" : "url associated with the log drain"
}
create_log_session
Create a new log session.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"tail" : "whether to stream ongoing logs",
"dyno" : "dyno to limit results to",
"source" : "log source to limit results to",
"lines" : "number of log lines to stream at once"
}
create_member_for_team
Create a new team member.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
$body
Type: object
{
"federated" : "whether the user is federated and belongs to an Identity Provider",
"role" : "role in the team",
"email" : "email address of the team member"
}
create_member_in_enterprise_account
Create a member in an enterprise account.
Parameters
Accept (required)
Type: string
enterprise-account_identity (required)
Type: string
$body
Type: object
{
"federated" : "whether membership is being created as part of SSO JIT",
"permissions" : [ "permission in the enterprise account" ],
"user" : "unique identifier or name of account member"
}
create_oauth_authorizations
Create a new OAuth authorization.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"scope" : [ "string" ],
"client" : "unique identifier of OAuth client",
"description" : "human-friendly description of this OAuth authorization",
"expires_in" : "seconds until OAuth token expires; may be `null` for tokens with indefinite lifetime"
}
create_oauth_client
Create a new OAuth client.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"name" : "OAuth client name",
"redirect_uri" : "endpoint for redirection after authorization with OAuth client"
}
create_oauth_token
Create a new OAuth token.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"refresh_token" : {
"token" : "contents of the token to be used for authorization"
},
"client" : {
"secret" : "secret used to obtain OAuth authorizations under this client"
},
"grant" : {
"code" : "grant code received from OAuth web application authorization",
"type" : "type of grant requested, one of `authorization_code` or `refresh_token`"
}
}
create_outbound_ruleset
Create a new outbound ruleset
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
$body
Type: object
{
"rules" : [ {
"protocol" : "formal standards and policies comprised of rules, procedures and formats that define communication between two or more devices over a network",
"to_port" : "an endpoint of communication in an operating system.",
"from_port" : "Required outbound-ruleset_port",
"target" : "is the target destination in CIDR notation"
} ]
}
create_pipeline
Create a new pipeline.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"name" : "name of pipeline"
}
create_pipeline_coupling
Create a new pipeline coupling.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"app" : "unique identifier or name of app",
"pipeline" : "unique identifier of pipeline",
"stage" : "target pipeline stage"
}
create_pipeline_promotion
Create a new promotion.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"pipeline" : {
"id" : "unique identifier of pipeline"
},
"source" : {
"app" : {
"id" : "unique identifier of app"
}
},
"targets" : [ {
"app" : {
"id" : "app_id"
}
} ]
}
create_review_app
Create a new review app
Parameters
Accept (required)
Type: string
$body
Type: object
{
"pipeline" : "unique identifier of pipeline",
"environment" : { },
"fork_repo_id" : "repository id of the fork the branch resides in",
"branch" : "the branch of the repository which the review app is based on",
"source_blob" : {
"version" : "The version number (or SHA) of the code to build.",
"url" : "URL where gzipped tar archive of source code for build was downloaded."
}
}
create_slug
Create a new slug. For more information please refer to Deploying Slugs using the Platform API.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"stack" : "unique identifier or name of stack",
"process_types" : { },
"commit_description" : "an optional description of the provided commit",
"checksum" : "an optional checksum of the slug for verifying its integrity",
"commit" : "identification of the code with your version control system (eg: SHA of the git HEAD)",
"buildpack_provided_description" : "description from buildpack of slug"
}
create_sni_endpoint_for_app
Create a new SNI endpoint.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"private_key" : "contents of the private key (eg .key file)",
"certificate_chain" : "raw contents of the public certificate chain (eg: .crt or .pem file)"
}
create_source
Create URLs for uploading and downloading source.
Parameters
Accept (required)
Type: string
create_source_url
Create URLs for uploading and downloading source. Deprecated in favor of POST /sources
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
create_space
Create a new space.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"shield" : "true if this space has shield enabled",
"data_cidr" : "The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that's automatically created when using Heroku Data add-ons. It must be between a /16 and a /20",
"name" : "unique name of space",
"cidr" : "The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16",
"team" : "unique name of team",
"region" : "unique identifier or name of region"
}
create_ssl_endpoint_for_app
Create a new SSL endpoint.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"preprocess" : "allow Heroku to modify an uploaded public certificate chain if deemed advantageous by adding missing intermediaries, stripping unnecessary ones, etc.",
"private_key" : "contents of the private key (eg .key file)",
"certificate_chain" : "raw contents of the public certificate chain (eg: .crt or .pem file)"
}
create_team
Create a new team.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"country" : "country",
"cvv" : "card verification value",
"other" : "metadata",
"card_number" : "encrypted card number of payment method",
"city" : "city",
"address_1" : "street address line 1",
"address_2" : "street address line 2",
"last_name" : "the last name for payment method",
"nonce" : "Nonce generated by Braintree hosted fields form",
"expiration_year" : "expiration year",
"device_data" : "Device data string generated by the client",
"name" : "unique name of team",
"expiration_month" : "expiration month",
"state" : "state",
"postal_code" : "postal code",
"first_name" : "the first name for payment method"
}
create_team_in_enterprise_account
Create a team in an enterprise account.
Parameters
Accept (required)
Type: string
enterprise-account_identity (required)
Type: string
$body
Type: object
{
"name" : "unique name of team"
}
create_test_run
Create a new test-run.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"pipeline" : "unique identifier or name of pipeline",
"commit_sha" : "the SHA hash of the commit under test",
"debug" : "whether the test run was started for interactive debugging",
"organization" : "unique identifier or name of team",
"source_blob_url" : "The download location for the source code to be tested",
"commit_branch" : "the branch of the repository that the test run concerns",
"commit_message" : "the message for the commit under test"
}
create_vpn_connection
Create a new VPN connection in a private space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
$body
Type: object
{
"public_ip" : "Public IP of VPN customer gateway",
"routable_cidrs" : [ "string" ],
"name" : "VPN Name"
}
create_webhook_for_add_on
Create an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
$body
Type: object
{
"authorization" : "a custom `Authorization` header that Heroku will include with all webhook notifications",
"include" : [ "string" ],
"level" : "if `notify`, Heroku makes a single, fire-and-forget delivery attempt. If `sync`, Heroku attempts multiple deliveries until the request is successful or a limit is reached",
"secret" : "a value that Heroku will use to sign all webhook notification requests (the signature is included in the request’s `Heroku-Webhook-Hmac-SHA256` header)",
"url" : "the URL where the webhook's notification requests are sent"
}
delete_account
Delete account. Note that this action cannot be undone.
Parameters
Accept (required)
Type: string
delete_add_on_for_app
Delete an existing add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
app_identity (required)
Type: string
delete_app
Delete an existing app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
delete_app_transfer
Delete an existing app transfer
Parameters
Accept (required)
Type: string
app-transfer_identity (required)
Type: string
delete_attachment_for_add_on
Delete an existing add-on attachment.
Parameters
Accept (required)
Type: string
add-on-attachment_identity (required)
Type: string
delete_collaborator_for_app
Delete an existing collaborator.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
collaborator_identity (required)
Type: string
delete_collaborator_from_app_for_team
Delete an existing collaborator from a team app.
Parameters
Accept (required)
Type: string
team-app-collaborator_identity (required)
Type: string
team-app_identity (required)
Type: string
delete_domain_for_app
Delete an existing domain
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
domain_identity (required)
Type: string
delete_identity_provider_for_team
Delete a team's Identity Provider
Parameters
Accept (required)
Type: string
identity-provider_id (required)
Type: string
team_name (required)
Type: string
delete_log_drain
Delete an existing log drain. Log drains added by add-ons can only be removed by removing the add-on.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
log-drain_query_identity (required)
Type: string
delete_member_from_enterprise_account
Delete a member in an enterprise account.
Parameters
Accept (required)
Type: string
enterprise-account-member_user_identity (required)
Type: string
enterprise-account_identity (required)
Type: string
delete_oauth_authorization
Delete OAuth authorization.
Parameters
Accept (required)
Type: string
oauth-authorization_identity (required)
Type: string
delete_oauth_client
Delete OAuth client.
Parameters
Accept (required)
Type: string
oauth-client_identity (required)
Type: string
delete_pipeline
Delete an existing pipeline.
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
delete_pipeline_coupling
Delete an existing pipeline coupling.
Parameters
Accept (required)
Type: string
pipeline-coupling_identity (required)
Type: string
delete_review_app
Delete an existing review app
Parameters
Accept (required)
Type: string
review-app_id (required)
Type: string
delete_sni_endpoint_for_app
Delete existing SNI endpoint.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
sni-endpoint_identity (required)
Type: string
delete_space
Delete an existing space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
delete_ssl_endpoint_for_app
Delete existing SSL endpoint.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
ssl-endpoint_identity (required)
Type: string
delete_team
Delete an existing team.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
delete_user
Delete account. Note that this action cannot be undone.
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
destroy_build_cache_for_app
Destroy a build cache.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
destroy_peering_connection_for_space
Destroy an active peering connection with a private space.
Parameters
Accept (required)
Type: string
peering_pcx_id (required)
Type: string
space_identity (required)
Type: string
destroy_vpn_connection
Destroy existing VPN Connection
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
vpn-connection_identity (required)
Type: string
disable_acm_flag_for_app
Disable ACM flag for an app
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
disable_review_apps_for_pipeline
Disable review apps for a pipeline
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
enable_acm_flag_for_app
Enable ACM flag for an app
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
enable_review_apps_for_pipeline
Enable review apps for a pipeline
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
$body
Type: object
{
"repo" : "repository name",
"automatic_review_apps" : "enable automatic review apps for pull requests",
"wait_for_ci" : "If true, review apps are created only when CI passes",
"stale_days" : "number of days without a deployment after which to consider a review app stale",
"destroy_stale_apps" : "automatically destroy review apps when they haven't been deployed for a number of days",
"deploy_target" : {
"id" : "unique identifier of deploy target",
"type" : "type of deploy target"
}
}
get_account
Info for account.
Parameters
Accept (required)
Type: string
get_add_on
Info for an existing add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
get_add_on_attachment_for_app
Info for existing add-on attachment for an app.
Parameters
Accept (required)
Type: string
add-on-attachment_scopedIdentity (required)
Type: string
app_identity (required)
Type: string
get_add_on_for_app
Info for an existing add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
app_identity (required)
Type: string
get_add_on_service
Info for existing add-on-service.
Parameters
Accept (required)
Type: string
add-on-service_identity (required)
Type: string
get_app
Info for existing app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
get_app_feature
Info for an existing app feature.
Parameters
Accept (required)
Type: string
app-feature_identity (required)
Type: string
app_identity (required)
Type: string
get_app_for_team
Info for a team app.
Parameters
Accept (required)
Type: string
team-app_identity (required)
Type: string
get_app_transfer
Info for existing app transfer.
Parameters
Accept (required)
Type: string
app-transfer_identity (required)
Type: string
get_archive_for_month_for_enterprise_account
List existing archives.
Parameters
Accept (required)
Type: string
enterprise-account_identity (required)
Type: string
get_attachment_for_add_on
Info for existing add-on attachment.
Parameters
Accept (required)
Type: string
add-on-attachment_identity (required)
Type: string
get_build_for_app
Info for existing build.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
build_identity (required)
Type: string
get_collaborator_on_app
Info for existing collaborator.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
collaborator_identity (required)
Type: string
get_collaborator_on_app_for_team
Info for a collaborator on a team app.
Parameters
Accept (required)
Type: string
team-app-collaborator_identity (required)
Type: string
team-app_identity (required)
Type: string
get_config_for_add_on
Get an add-on's config. Accessible by customers with access and by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
get_config_vars_for_app
Get config-vars for app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
get_config_vars_for_pipeline_stage
Get config-vars for a pipeline stage.
Parameters
Accept (required)
Type: string
pipeline-coupling_stage (required)
Type: string
pipeline_id (required)
Type: string
get_config_vars_for_release_for_app
Get config-vars for a release.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
release_identity (required)
Type: string
get_credit_for_account
Info for existing credit.
Parameters
Accept (required)
Type: string
credit_identity (required)
Type: string
get_credits_for_account
List existing credits.
Parameters
Accept (required)
Type: string
get_current_inbound_ruleset_for_space
Current inbound ruleset for a space
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
get_current_outbound_ruleset_for_space
Current outbound ruleset for a space
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
get_daily_usage_for_enterprise_account
Retrieves usage for an enterprise account for a range of days. Start and end dates can be specified as query parameters using the date format, YYYY-MM-DD format. For example, '/enterprise-accounts/example-account/usage/daily?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.
Parameters
Accept (required)
Type: string
enterprise-account_id (required)
Type: string
get_daily_usage_for_team
Retrieves usage for an enterprise team for a range of days. Start and end dates can be specified as query parameters using the date format, YYYY-MM-DD format. For example, '/teams/example-team/usage?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.
Parameters
Accept (required)
Type: string
team_id (required)
Type: string
get_domain_for_app
Info for existing domain.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
domain_identity (required)
Type: string
get_dyno_for_app
Info for existing dyno.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
dyno_identity (required)
Type: string
get_dyno_size
Info for existing dyno size.
Parameters
Accept (required)
Type: string
dyno-size_identity (required)
Type: string
get_enterprise_account
Information about an enterprise account.
Parameters
Accept (required)
Type: string
enterprise-account_identity (required)
Type: string
get_event_for_webhook
Returns the info for a specified webhook event.
Parameters
Accept (required)
Type: string
app-webhook-event_identity (required)
Type: string
app_identity (required)
Type: string
get_event_for_webhook_for_add_on
Returns the info for a specified webhook event. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
app-webhook-event_identity (required)
Type: string
get_feature_for_account
Info for an existing account feature.
Parameters
Accept (required)
Type: string
account-feature_identity (required)
Type: string
get_feature_for_team
Info for an existing team feature.
Parameters
Accept (required)
Type: string
team-feature_identity (required)
Type: string
team_identity (required)
Type: string
get_inbound_ruleset_for_space
Info on an existing Inbound Ruleset
Parameters
Accept (required)
Type: string
inbound-ruleset_identity (required)
Type: string
space_identity (required)
Type: string
get_invitation_for_team
Get an invitation by its token
Parameters
Accept (required)
Type: string
team-invitation_token (required)
Type: string
get_invoice
Info for existing invoice.
Parameters
Accept (required)
Type: string
team-invoice_identity (required)
Type: string
team_identity (required)
Type: string
get_invoice_address_for_account
Retrieve existing invoice address.
Parameters
Accept (required)
Type: string
get_invoice_for_account
Info for existing invoice.
Parameters
Accept (required)
Type: string
invoice_identity (required)
Type: string
get_key
Info for existing key.
Parameters
Accept (required)
Type: string
key_identity (required)
Type: string
get_log_drain_for_app
Info for existing log drain.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
log-drain_query_identity (required)
Type: string
get_monthly_usage_for_team
Retrieves usage for an enterprise team for a range of months. Start and end dates can be specified as query parameters using the date format, YYYY-MM format. For example, '/teams/example-team/usage?start=2019-01&end=2019-02' specifies usage in January and February for 2019. If no end date is specified, one month of usage is returned.
Parameters
Accept (required)
Type: string
team_id (required)
Type: string
get_nat_state_for_space
Current state of network address translation for a space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
get_oauth_authorization
Info for an OAuth authorization.
Parameters
Accept (required)
Type: string
oauth-authorization_identity (required)
Type: string
get_oauth_client
Info for an OAuth client
Parameters
Accept (required)
Type: string
oauth-client_identity (required)
Type: string
get_outbound_ruleset_for_space
Info on an existing Outbound Ruleset
Parameters
Accept (required)
Type: string
outbound-ruleset_identity (required)
Type: string
space_identity (required)
Type: string
get_peering_connection_for_space
Fetch information for existing peering connection
Parameters
Accept (required)
Type: string
peering_pcx_id (required)
Type: string
space_identity (required)
Type: string
get_peering_info_for_space
Provides the necessary information to establish an AWS VPC Peering with your private space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
get_pipeline
Info for existing pipeline.
Parameters
Accept (required)
Type: string
pipeline_identity (required)
Type: string
get_pipeline_coupling
Info for an existing pipeline coupling.
Parameters
Accept (required)
Type: string
pipeline-coupling_identity (required)
Type: string
get_pipeline_coupling_for_app
Info for an existing app pipeline coupling.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
get_pipeline_promotion
Info for existing pipeline promotion.
Parameters
Accept (required)
Type: string
pipeline-promotion_identity (required)
Type: string
get_plan
Info for existing plan.
Parameters
Accept (required)
Type: string
plan_identity (required)
Type: string
get_plan_for_add_on
Info for existing plan by Add-on.
Parameters
Accept (required)
Type: string
add-on-service_identity (required)
Type: string
plan_identity (required)
Type: string
get_preferences_for_user
Retrieve User Preferences
Parameters
Accept (required)
Type: string
user-preferences_identity (required)
Type: string
get_process_type_for_formation_for_app
Info for a process type
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
formation_identity (required)
Type: string
get_rate_limits_for_account
Info for rate limits.
Parameters
Accept (required)
Type: string
get_region
Info for existing region.
Parameters
Accept (required)
Type: string
region_identity (required)
Type: string
get_release_for_app
Info for existing release.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
release_identity (required)
Type: string
get_review_app
Gets an existing review app
Parameters
Accept (required)
Type: string
review-app_id (required)
Type: string
get_review_app_config_for_pipeline
Get review apps configuration for a pipeline
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
get_review_app_for_app
Get a review app using the associated app_id
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
get_schema
Parameters
Accept (required)
Type: string
get_single_month_archive_for_enterprise_account
Get archive for a single month.
Parameters
Accept (required)
Type: string
archive_month (required)
Type: string
archive_year (required)
Type: string
enterprise-account_identity (required)
Type: string
get_slug_for_app
Info for existing slug.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
slug_identity (required)
Type: string
get_sni_endpoint
Info for existing SNI endpoint.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
sni-endpoint_identity (required)
Type: string
get_space
Info for existing space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
get_ssl_endpoing_for_app
Info for existing SSL endpoint.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
ssl-endpoint_identity (required)
Type: string
get_stack
Stack info.
Parameters
Accept (required)
Type: string
stack_identity (required)
Type: string
get_status_of_app_setup
Get the status of an app setup.
Parameters
Accept (required)
Type: string
app-setup_identity (required)
Type: string
get_team
Info for a team.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
get_test_run
Info for existing test-run.
Parameters
Accept (required)
Type: string
test-run_id (required)
Type: string
get_test_run_for_pipeline
Info for existing test-run by Pipeline
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
test-run_number (required)
Type: string
get_usage_for_enterprise_account
Retrieves usage for an enterprise account for a range of months. Start and end dates can be specified as query parameters using the date format, YYYY-MM format. For example, '/enterprise-accounts/example-account/usage/monthly?start=2019-01&end=2019-02' specifies usage in January and February for 2019. If no end date is specified, one month of usage is returned.
Parameters
Accept (required)
Type: string
enterprise-account_id (required)
Type: string
get_user
Info for account.
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
get_vpn_connection
Info for an existing vpn-connection.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
vpn-connection_identity (required)
Type: string
get_webhook_delivery_for_add_on
Returns the info for an existing delivery. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
app-webhook-delivery_identity (required)
Type: string
get_webhook_delivery_for_app
Returns the info for an existing delivery.
Parameters
Accept (required)
Type: string
app-webhook-delivery_identity (required)
Type: string
app_identity (required)
Type: string
get_webhook_for_add_on
Returns the info for an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
app-webhook_identity (required)
Type: string
get_webhook_for_app
Returns the info for an app webhook subscription.
Parameters
Accept (required)
Type: string
app-webhook_identity (required)
Type: string
app_identity (required)
Type: string
list_add_on_attachments_for_add_on
List existing add-on attachments for an add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
list_add_on_attachments_for_app
List existing add-on attachments for an app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_add_on_region_capabilities_for_region
List existing add-on region capabilities for a region.
Parameters
Accept (required)
Type: string
region_identity (required)
Type: string
list_add_on_services
List existing add-on-services.
Parameters
Accept (required)
Type: string
list_add_ons_for_app
List existing add-ons for an app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_add_ons_for_team
List add-ons used across all Team apps
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
list_add_ons_for_user
List all existing add-ons a user has access to
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
list_addon_attachments
List existing add-on attachments.
Parameters
Accept (required)
Type: string
list_addon_region_capabilities
List all existing add-on region capabilities.
Parameters
Accept (required)
Type: string
list_addons
List all existing add-ons.
Parameters
Accept (required)
Type: string
list_app_transfers
List existing apps transfers.
Parameters
Accept (required)
Type: string
list_apps
List existing apps.
Parameters
Accept (required)
Type: string
list_apps_for_member_of_team
List the apps of a team member.
Parameters
Accept (required)
Type: string
team-member_identity (required)
Type: string
team_identity (required)
Type: string
list_apps_for_team
List team apps.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
list_apps_for_user
List owned and collaborated apps (excludes team apps).
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
list_available_permissions_for_teams
Lists permissions available to teams.
Parameters
Accept (required)
Type: string
list_buildpack_installations_for_app
List an app's existing buildpack installations.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_builds_for_app
List existing build.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_collaborators_for_app
List existing collaborators.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_collaborators_of_team_app
List collaborators on a team app.
Parameters
Accept (required)
Type: string
team-app_identity (required)
Type: string
list_couplings_for_pipeline
List couplings for a pipeline
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
list_domains_for_app
List existing domains.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_dynos
List existing dynos.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_enterprise_accounts
List enterprise accounts in which you are a member.
Parameters
Accept (required)
Type: string
list_events_for_enterprise_account
List existing events.
Parameters
Accept (required)
Type: string
enterprise-account_identity (required)
Type: string
list_events_for_webhook_for_add_on
Lists existing webhook events for an add-on. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
list_events_for_webhook_for_app
Lists existing webhook events for an app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_features_for_account
List existing account features.
Parameters
Accept (required)
Type: string
list_features_for_app
List existing app features.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_features_for_team
List existing team features.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
list_identity_providers_for_team
Get a list of a team's Identity Providers
Parameters
Accept (required)
Type: string
team_name (required)
Type: string
list_inbound_rulesets_for_space
List all inbound rulesets for a space
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
list_invitations_for_team
Get a list of a team's Invitations
Parameters
Accept (required)
Type: string
team_name (required)
Type: string
list_invoices_for_account
List existing invoices.
Parameters
Accept (required)
Type: string
list_invoices_for_team
List existing invoices.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
list_keys_for_account
List existing keys.
Parameters
Accept (required)
Type: string
list_log_drains
List existing log drains.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_log_drains_for_add_on
List existing log drains for an add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
list_members_for_team
List members of the team.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
list_members_in_enterprise_account
List members in an enterprise account.
Parameters
Accept (required)
Type: string
enterprise-account_identity (required)
Type: string
list_members_of_space
List all users and their permissions on a space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
list_oauth_authorizations
List OAuth authorizations.
Parameters
Accept (required)
Type: string
list_oauth_clients
List OAuth clients
Parameters
Accept (required)
Type: string
list_outbound_rulesets_for_space
List all Outbound Rulesets for a space
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
list_peering_connections_for_space
List peering connections of a private space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
list_permissions_for_team
List permission entities for a team.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
list_permissions_for_user
List permissions for a given user on a given space.
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
space_identity (required)
Type: string
list_pipeline_couplings
List pipeline couplings.
Parameters
Accept (required)
Type: string
list_pipeline_couplings_for_current_user
List pipeline couplings for the current user.
Parameters
Accept (required)
Type: string
list_pipelines
List existing pipelines.
Parameters
Accept (required)
Type: string
list_plans_by_add_on
List existing plans by Add-on.
Parameters
Accept (required)
Type: string
add-on-service_identity (required)
Type: string
list_preferences_for_team
Retrieve Team Preferences
Parameters
Accept (required)
Type: string
team-preferences_identity (required)
Type: string
list_process_types_For_formation_for_app
List process type formation
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_region_capabilities_for_add_on
List existing add-on region capabilities for an add-on-service
Parameters
Accept (required)
Type: string
add-on-service_identity (required)
Type: string
list_regions
List existing regions.
Parameters
Accept (required)
Type: string
list_releases_for_app
List existing releases.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_review_apps_for_pipeline
List review apps for a pipeline
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
list_sizes_for_dyno
List existing dyno sizes.
Parameters
Accept (required)
Type: string
list_sni_endpoints_for_app
List existing SNI endpoints.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_spaces
List existing spaces.
Parameters
Accept (required)
Type: string
list_spaces_for_team
List spaces owned by the team
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
list_ssl_endpoints_for_app
List existing SSL endpoints.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_stacks
List available stacks.
Parameters
Accept (required)
Type: string
list_targets_for_pipeline_promotion
List promotion targets belonging to an existing promotion.
Parameters
Accept (required)
Type: string
pipeline-promotion_id (required)
Type: string
list_teams
List teams in which you are a member.
Parameters
Accept (required)
Type: string
list_teams_for_enterprise_account
List teams for an enterprise account.
Parameters
Accept (required)
Type: string
enterprise-account_identity (required)
Type: string
list_test_cases_for_test_run
List test cases
Parameters
Accept (required)
Type: string
test-run_id (required)
Type: string
list_test_nodes
List test nodes
Parameters
Accept (required)
Type: string
test-run_identity (required)
Type: string
list_test_runs_for_pipeline
List existing test-runs for a pipeline.
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
list_vpn_connections_for_space
List VPN connections for a space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
list_webhook_deliveries_for_add_on
Lists existing deliveries for an add-on. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
list_webhook_deliveries_for_app
Lists existing deliveries for an app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_webhooks_for_add_on
List all webhook subscriptions for a particular add-on. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
list_webhooks_for_app
List all webhook subscriptions for a particular app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
list_whitelisted_add_ons_for_team
List all whitelisted Add-on Services for an Team
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
mark_add_on_as_deprovisioned
Mark an add-on as deprovisioned.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
mark_add_on_as_provisioned
Mark an add-on as provisioned for use.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
recover_account_with_sms_code
Recover an account using an SMS recovery code
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
recover_account_with_sms_code_2
Recover an account using an SMS recovery code
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
refresh_acm_for_app
Refresh ACM for an app
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
regenerate_oauth_tokens
Regenerate OAuth tokens. This endpoint is only available to direct authorizations or privileged OAuth clients.
Parameters
Accept (required)
Type: string
oauth-authorization_identity (required)
Type: string
remove_member_from_team
Remove a member from the team.
Parameters
Accept (required)
Type: string
team-member_identity (required)
Type: string
team_identity (required)
Type: string
remove_webhook_for_add_on
Removes an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
app-webhook_identity (required)
Type: string
remove_whitelisted_add_on_service
Remove a whitelisted entity
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
whitelisted-add-on-service_identity (required)
Type: string
request_filtered_apps_list
Request an apps list filtered by app id.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"in" : {
"id" : [ "unique identifier of app" ]
}
}
request_password_reset
Reset account's password. This will send a reset password link to the user's email address.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"email" : "unique email address of account"
}
reset_password
Complete password reset.
Parameters
Accept (required)
Type: string
password-reset_reset_password_token (required)
Type: string
$body
Type: object
{
"password" : "current password on the account",
"password_confirmation" : "confirmation of the new password"
}
resolve_add_on
Resolve an add-on from a name, optionally passing an app name. If there are matches it returns at least one add-on (exact match) or many.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"app" : "unique name of app",
"addon" : "globally unique name of the add-on",
"addon_service" : "unique name of this add-on-service"
}
resolve_add_on_attachment
Resolve an add-on attachment from a name, optionally passing an app name. If there are matches it returns at least one add-on attachment (exact match) or many.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"app" : "unique name of app",
"addon_attachment" : "unique name for this add-on attachment to this app",
"addon_service" : "unique name of this add-on-service"
}
restart_dyno
Restart dyno.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
dyno_identity (required)
Type: string
restart_dynos
Restart all dynos.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
revoke_invitation_for_team
Revoke a team invitation.
Parameters
Accept (required)
Type: string
team-invitation_identity (required)
Type: string
team_identity (required)
Type: string
revoke_oauth_token
Revoke OAuth access token.
Parameters
Accept (required)
Type: string
oauth-token_identity (required)
Type: string
rollback_to_release
Rollback to an existing release.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"release" : "unique identifier of release"
}
rotate_credentials_for_oauth_client
Rotate credentials for an OAuth client
Parameters
Accept (required)
Type: string
oauth-client_identity (required)
Type: string
stop_dyno
Stop dyno.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
dyno_identity (required)
Type: string
subscribe_to_webhook_for_app
Create an app webhook subscription.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"authorization" : "a custom `Authorization` header that Heroku will include with all webhook notifications",
"include" : [ "string" ],
"level" : "if `notify`, Heroku makes a single, fire-and-forget delivery attempt. If `sync`, Heroku attempts multiple deliveries until the request is successful or a limit is reached",
"secret" : "a value that Heroku will use to sign all webhook notification requests (the signature is included in the request’s `Heroku-Webhook-Hmac-SHA256` header)",
"url" : "the URL where the webhook's notification requests are sent"
}
transfer_app_to_another_team
Transfer an existing team app to another team.
Parameters
Accept (required)
Type: string
team-app_identity (required)
Type: string
$body
Type: object
{
"owner" : "unique name of team"
}
transfer_space_between_teams
Transfer space between enterprise teams
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
$body
Type: object
{
"new_owner" : "unique name of team"
}
unsubscribe_from_webhook_in_app
Removes an app webhook subscription.
Parameters
Accept (required)
Type: string
app-webhook_identity (required)
Type: string
app_identity (required)
Type: string
update_account
Update account.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"allow_tracking" : "whether to allow third party web activity tracking",
"name" : "full name of the account owner",
"beta" : "whether allowed to utilize beta Heroku features"
}
update_app
Update an existing app.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"build_stack" : "unique identifier or name of stack",
"name" : "unique name of app",
"maintenance" : "maintenance status of app"
}
update_app_feature
Update an existing app feature.
Parameters
Accept (required)
Type: string
app-feature_identity (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"enabled" : "whether or not app feature has been enabled"
}
update_app_transfer
Update an existing app transfer.
Parameters
Accept (required)
Type: string
app-transfer_identity (required)
Type: string
$body
Type: object
{
"state" : "the current state of an app transfer"
}
update_buildpack_installation_for_app
Update an app's buildpack installations.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"updates" : [ {
"buildpack" : "location of the buildpack for the app. Either a url (unofficial buildpacks) or an internal urn (heroku official buildpacks)."
} ]
}
update_collaborator_for_app_for_team
Update an existing collaborator from a team app.
Parameters
Accept (required)
Type: string
team-app-collaborator_identity (required)
Type: string
team-app_identity (required)
Type: string
$body
Type: object
{
"permissions" : [ "The name of the app permission." ]
}
update_config_for_add_on
Update an add-on's config. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
$body
Type: object
{
"config" : [ {
"name" : "unique name of the config",
"value" : "value of the config"
} ]
}
update_config_for_review_app_in_pipeline
Update review app configuration for a pipeline
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
$body
Type: object
{
"automatic_review_apps" : "enable automatic review apps for pull requests",
"wait_for_ci" : "If true, review apps are created only when CI passes",
"stale_days" : "number of days without a deployment after which to consider a review app stale",
"destroy_stale_apps" : "automatically destroy review apps when they haven't been deployed for a number of days",
"deploy_target" : {
"id" : "unique identifier of deploy target",
"type" : "type of deploy target"
}
}
update_config_vars_for_app
Update config-vars for app. You can update existing config-vars by setting them again, and remove by setting it to null
.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
hash of config changes – update values or delete by seting it to null
Type: object
{ }
update_config_vars_for_stage_in_pipeline
Update config-vars for a pipeline stage. You can update existing config-vars by setting them again, and remove by setting it to null
.
Parameters
Accept (required)
Type: string
pipeline-coupling_stage (required)
Type: string
pipeline_id (required)
Type: string
$body
hash of config changes – update values or delete by seting it to null
Type: object
{ }
update_create_member_for_team
Create a new team member, or update their role.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
$body
Type: object
{
"federated" : "whether the user is federated and belongs to an Identity Provider",
"role" : "role in the team",
"email" : "email address of the team member"
}
update_feature_for_account
Update an existing account feature.
Parameters
Accept (required)
Type: string
account-feature_identity (required)
Type: string
$body
Type: object
{
"enabled" : "whether or not account feature has been enabled"
}
update_identity_provider_for_team
Update a team's Identity Provider
Parameters
Accept (required)
Type: string
identity-provider_id (required)
Type: string
team_name (required)
Type: string
$body
Type: object
{
"certificate" : "raw contents of the public certificate (eg: .crt or .pem file)",
"slo_target_url" : "single log out URL for this identity provider",
"sso_target_url" : "single sign on URL for this identity provider",
"entity_id" : "URL identifier provided by the identity provider"
}
update_invoice_address_for_account
Update invoice address for an account.
Parameters
Accept (required)
Type: string
$body
Type: object
{
"country" : "country",
"other" : "metadata / additional information to go on invoice",
"city" : "invoice city",
"use_invoice_address" : "flag to use the invoice address for an account or not",
"address_1" : "invoice street address line 1",
"address_2" : "invoice street address line 2",
"state" : "invoice state",
"postal_code" : "invoice zip code"
}
update_log_drain_for_add_on
Update an add-on owned log drain.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
log-drain_query_identity (required)
Type: string
$body
Type: object
{
"url" : "url associated with the log drain"
}
update_member_in_enterprise_account
Update a member in an enterprise account.
Parameters
Accept (required)
Type: string
enterprise-account-member_user_identity (required)
Type: string
enterprise-account_identity (required)
Type: string
$body
Type: object
{
"permissions" : [ "permission in the enterprise account" ]
}
update_member_of_team
Update a team member.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
$body
Type: object
{
"federated" : "whether the user is federated and belongs to an Identity Provider",
"role" : "role in the team",
"email" : "email address of the team member"
}
update_oauth_client
Update OAuth client
Parameters
Accept (required)
Type: string
oauth-client_identity (required)
Type: string
$body
Type: object
{
"name" : "OAuth client name",
"redirect_uri" : "endpoint for redirection after authorization with OAuth client"
}
update_permissions_for_user
Update an existing user's set of permissions on a space.
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
space_identity (required)
Type: string
$body
Type: object
{
"permissions" : [ {
"name" : "string"
} ]
}
update_pipeline
Update an existing pipeline.
Parameters
Accept (required)
Type: string
pipeline_id (required)
Type: string
$body
Type: object
{
"name" : "name of pipeline"
}
update_pipeline_coupling
Update an existing pipeline coupling.
Parameters
Accept (required)
Type: string
pipeline-coupling_identity (required)
Type: string
$body
Type: object
{
"stage" : "target pipeline stage"
}
update_preferences_for_team
Update Team Preferences
Parameters
Accept (required)
Type: string
team-preferences_identity (required)
Type: string
$body
Type: object
{
"whitelisting-enabled" : "Whether whitelisting rules should be applied to add-on installations"
}
update_preferences_for_user
Update User Preferences
Parameters
Accept (required)
Type: string
user-preferences_identity (required)
Type: string
$body
Type: object
{
"dismissed-github-banner" : "Whether the user has dismissed the GitHub link banner",
"timezone" : "User's default timezone",
"dismissed-org-wizard-notification" : "Whether the user has dismissed the Organization Wizard",
"dismissed-pipelines-github-banner" : "Whether the user has dismissed the GitHub banner on a pipeline overview",
"dismissed-pipelines-banner" : "Whether the user has dismissed the Pipelines banner",
"default-organization" : "User's default team",
"dismissed-org-access-controls" : "Whether the user has dismissed the Organization Access Controls banner",
"dismissed-pipelines-github-banners" : "Which pipeline uuids the user has dismissed the GitHub banner for",
"dismissed-getting-started" : "Whether the user has dismissed the getting started banner",
"dismissed-sms-banner" : "Whether the user has dismissed the 2FA SMS banner"
}
update_process_type
Batch update process types
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"updates" : [ {
"quantity" : "number of processes to maintain",
"size" : "dyno size (default: \"standard-1X\")",
"type" : "type of process to maintain"
} ]
}
update_process_type_for_formation_for_app
Update process type
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
formation_identity (required)
Type: string
$body
Type: object
{
"quantity" : "number of processes to maintain",
"size" : "dyno size (default: \"standard-1X\")"
}
update_properties_for_enterprise_account
Update enterprise account properties
Parameters
Accept (required)
Type: string
enterprise-account_identity (required)
Type: string
$body
Type: object
{
"name" : "unique name of the enterprise account"
}
update_sni_endpoint
Update an existing SNI endpoint.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
sni-endpoint_identity (required)
Type: string
$body
Type: object
{
"private_key" : "contents of the private key (eg .key file)",
"certificate_chain" : "raw contents of the public certificate chain (eg: .crt or .pem file)"
}
update_space
Update an existing space.
Parameters
Accept (required)
Type: string
space_identity (required)
Type: string
$body
Type: object
{
"name" : "unique name of space"
}
update_ssl_endpoint
Update an existing SSL endpoint.
Parameters
Accept (required)
Type: string
app_identity (required)
Type: string
ssl-endpoint_identity (required)
Type: string
$body
Type: object
{
"rollback" : "indicates that a rollback should be performed",
"preprocess" : "allow Heroku to modify an uploaded public certificate chain if deemed advantageous by adding missing intermediaries, stripping unnecessary ones, etc.",
"private_key" : "contents of the private key (eg .key file)",
"certificate_chain" : "raw contents of the public certificate chain (eg: .crt or .pem file)"
}
update_status_of_test_run
Update a test-run's status.
Parameters
Accept (required)
Type: string
test-run_number (required)
Type: string
$body
Type: object
{
"message" : "human friendly message indicating reason for an error",
"status" : "current state of the test run"
}
update_team
Update team properties.
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
$body
Type: object
{
"default" : "whether to use this team when none is specified",
"name" : "unique name of team"
}
update_user
Update account.
Parameters
Accept (required)
Type: string
account_identity (required)
Type: string
$body
Type: object
{
"allow_tracking" : "whether to allow third party web activity tracking",
"name" : "full name of the account owner",
"beta" : "whether allowed to utilize beta Heroku features"
}
update_webhook
Updates the details of an app webhook subscription.
Parameters
Accept (required)
Type: string
app-webhook_identity (required)
Type: string
app_identity (required)
Type: string
$body
Type: object
{
"authorization" : "a custom `Authorization` header that Heroku will include with all webhook notifications",
"include" : [ "string" ],
"level" : "if `notify`, Heroku makes a single, fire-and-forget delivery attempt. If `sync`, Heroku attempts multiple deliveries until the request is successful or a limit is reached",
"secret" : "a value that Heroku will use to sign all webhook notification requests (the signature is included in the request’s `Heroku-Webhook-Hmac-SHA256` header)",
"url" : "the URL where the webhook's notification requests are sent"
}
update_webhook_for_add_on
Updates the details of an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.
Parameters
Accept (required)
Type: string
add-on_identity (required)
Type: string
app-webhook_identity (required)
Type: string
$body
Type: object
{
"authorization" : "a custom `Authorization` header that Heroku will include with all webhook notifications",
"include" : [ "string" ],
"level" : "if `notify`, Heroku makes a single, fire-and-forget delivery attempt. If `sync`, Heroku attempts multiple deliveries until the request is successful or a limit is reached",
"secret" : "a value that Heroku will use to sign all webhook notification requests (the signature is included in the request’s `Heroku-Webhook-Hmac-SHA256` header)",
"url" : "the URL where the webhook's notification requests are sent"
}
whitelist_add_on_for_team
Whitelist an Add-on Service
Parameters
Accept (required)
Type: string
team_identity (required)
Type: string
$body
Type: object
{
"addon_service" : "name of the Add-on to whitelist"
}