modulepackage
4.0.0+incompatible
Repository: https://github.com/davidji99/heroku-go.git
Documentation: pkg.go.dev
# README
Heroku Platform API
An API client interface for Heroku Platform API for the Go (golang) programming language.
Usage
import "github.com/heroku/heroku-go"
Example
package main
import (
"context"
"flag"
"fmt"
"log"
"github.com/heroku/heroku-go"
)
var (
username = flag.String("username", "", "api username")
password = flag.String("password", "", "api password")
)
func main() {
log.SetFlags(0)
flag.Parse()
heroku.DefaultTransport.Username = *username
heroku.DefaultTransport.Password = *password
h := heroku.NewService(heroku.DefaultClient)
addons, err := h.AddOnList(context.TODO(), &heroku.ListRange{Field: "name"})
if err != nil {
log.Fatal(err)
}
for _, addon := range addons {
fmt.Println(addon.Name)
}
}
# Functions
Bool allocates a new int value returns a pointer to it.
Float64 allocates a new float64 value returns a pointer to it.
Int allocates a new int value returns a pointer to it.
NewService creates a Service using the given, if none is provided it uses http.DefaultClient.
String allocates a new string value returns a pointer to it.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
# Structs
An account represents an individual signed up to use the Heroku platform.
An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
No description provided by the author
No description provided by the author
No description provided by the author
Add-ons represent add-ons that have been provisioned and attached to one or more apps.
Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning.
No description provided by the author
No description provided by the author
An add-on attachment represents a connection between an app and an add-on that it has been given access to.
No description provided by the author
No description provided by the author
Configuration of an Add-on.
No description provided by the author
No description provided by the author
Add-on Plan Actions are Provider functionality for specific add-on installations.
Add-on region capabilities represent the relationship between an Add-on Service and a specific Region.
No description provided by the author
Add-on services represent add-ons that may be provisioned for apps.
No description provided by the author
Represents the details of a webhook subscription.
No description provided by the author
No description provided by the author
No description provided by the author
Represents the delivery of a webhook notification, including its current status.
No description provided by the author
Represents a webhook event that occurred.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An app represents the program that you would like to deploy and run on Heroku.
No description provided by the author
An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.
No description provided by the author
App formation set describes the combination of process types with their quantities and sizes as well as application process tier.
An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
No description provided by the author
An app transfer represents a two party interaction for transferring ownership of an app.
No description provided by the author
No description provided by the author
No description provided by the author
Represents the details of a webhook subscription.
No description provided by the author
No description provided by the author
No description provided by the author
Represents the delivery of a webhook notification, including its current status.
Represents a webhook event that occurred.
No description provided by the author
No description provided by the author
No description provided by the author
A build represents the process of transforming a code tarball into a slug.
No description provided by the author
A buildpack installation represents a buildpack that will be run against an app.
No description provided by the author
A build result contains the output from a build.
A collaborator represents an account that has been given access to an app on Heroku.
No description provided by the author
A credit represents value that will be used up before further charges are assigned to an account.
No description provided by the author
Domains define what web routes should be routed to an app on Heroku.
No description provided by the author
Dynos encapsulate running processes of an app on Heroku.
No description provided by the author
No description provided by the author
No description provided by the author
Dyno sizes are the values and details of sizes that can be assigned to dynos.
No description provided by the author
No description provided by the author
Filters are special endpoints to allow for API consumers to specify a subset of resources to consume in order to reduce the number of requests that are performed.
No description provided by the author
The formation of processes that should be maintained for an app.
No description provided by the author
No description provided by the author
Identity Providers represent the SAML configuration of an Organization.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An inbound-ruleset is a collection of rules that specify what hosts can or cannot connect to an application.
No description provided by the author
An invoice is an itemized bill of goods for an account which includes pricing and charges.
An invoice address represents the address that should be listed on an invoice.
No description provided by the author
Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.
ListRange describes a range.
[Log drains](https://devcenter.heroku.com/articles/log-drains) provide a way to forward your Heroku logs to an external syslog server for long-term archiving.
No description provided by the author
No description provided by the author
A log session is a reference to the http based log stream for an app.
No description provided by the author
OAuth authorizations represent clients that a Heroku user has authorized to automate, customize or extend their usage of the platform.
No description provided by the author
OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform.
No description provided by the author
No description provided by the author
OAuth grants are used to obtain authorizations on behalf of a user.
OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform.
No description provided by the author
Deprecated: Organizations allow you to manage access to a shared group of applications across your development team.
Deprecated: A list of add-ons the Organization uses across all apps.
Deprecated: An organization app encapsulates the organization specific functionality of Heroku apps.
Deprecated: An organization collaborator represents an account that has been given access to an organization app on Heroku.
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: An organization app permission is a behavior that is assigned to a user in an organization app.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: An organization feature represents a feature enabled on an organization account.
No description provided by the author
Deprecated: An organization invitation represents an invite to an organization.
No description provided by the author
No description provided by the author
Deprecated: An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.
Deprecated: An organization member is an individual with access to an organization.
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Tracks an organization's preferences.
No description provided by the author
No description provided by the author
An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with.
No description provided by the author
A password reset represents a in-process password reset attempt.
No description provided by the author
No description provided by the author
[Peering](https://devcenter.heroku.com/articles/private-space-vpc-peer ing) provides a way to peer your Private Space VPC to another AWS VPC.
[Peering Info](https://devcenter.heroku.com/articles/private-space-vpc-peering) gives you the information necessary to peer an AWS VPC to a Private Space.
A pipeline allows grouping of apps into different stages.
Information about an app's coupling to a pipeline.
No description provided by the author
No description provided by the author
No description provided by the author
Promotions allow you to move code from an app in a pipeline to all targets.
No description provided by the author
Promotion targets represent an individual app being promoted to.
No description provided by the author
Plans represent different configurations of add-ons that may be added to apps.
Rate Limit represents the number of request tokens each account holds.
A region represents a geographic location in which your application may run.
A release represents a combination of code, config vars and add-ons for an app on Heroku.
No description provided by the author
No description provided by the author
net/http RoundTripper interface, a.k.a.
Service represents your API.
A slug is a snapshot of your application code that is ready to run on the platform.
No description provided by the author
SMS numbers are used for recovery on accounts with two-factor authentication enabled.
SNI Endpoint is a public address serving a custom SSL cert for HTTPS traffic, using the SNI TLS extension, to a Heroku app.
No description provided by the author
No description provided by the author
A source is a location for uploading and downloading an application's source code.
A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.
Space access represents the permissions a particular user has on a particular space.
No description provided by the author
No description provided by the author
Network address translation (NAT) for stable outbound IP addresses from a space.
No description provided by the author
[SSL Endpoint](https://devcenter.heroku.com/articles/ssl-endpoint) is a public address serving custom SSL cert for HTTPS traffic to a Heroku app.
No description provided by the author
No description provided by the author
Stacks are the different application execution environments available in the Heroku platform.
Teams allow you to manage access to a shared group of applications and other resources.
A team app encapsulates the team specific functionality of Heroku apps.
A team collaborator represents an account that has been given access to a team app on Heroku.
No description provided by the author
No description provided by the author
No description provided by the author
A team app permission is a behavior that is assigned to a user in a team app.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A team feature represents a feature enabled on a team account.
A team invitation represents an invite to a team.
No description provided by the author
No description provided by the author
A Team Invoice is an itemized bill of goods for a team which includes pricing and charges.
A team member is an individual with access to a team.
No description provided by the author
No description provided by the author
No description provided by the author
Tracks a Team's Preferences.
No description provided by the author
No description provided by the author
A single test case belonging to a test run.
A single test node belonging to a test run.
An execution or trial of one or more tests.
No description provided by the author
No description provided by the author
No description provided by the author
Tracks a user's preferences and message dismissals.
No description provided by the author
[VPN](https://devcenter.heroku.com/articles/private-spaces-vpn?preview =1) provides a way to connect your Private Spaces to your network via VPN.
No description provided by the author
Entities that have been whitelisted to be used by an Organization.
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Config Vars allow you to manage the configuration information provided to an app on Heroku.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author