ex_heroku_client v0.1.0 Heroku.Addon
Summary
Functions
Calls POST /apps/#{app_identity}/addons
Calls DELETE /apps/#{app_identity}/addons/#{addon_identity}
Calls GET /apps/#{app_identity}/addons/#{addon_identity}
Calls GET /addons/#{addon_identity}
Calls GET /addons
Calls GET /users/#{account_identity}/addons
Calls GET /apps/#{app_identity}/addons
Calls PATCH /apps/#{app_identity}/addons/#{addon_identity}
Functions
Calls POST /apps/#{app_identity}/addons
params
is JSON encoded and passed as the request body.
params Schema
{
"properties": {
"attachment": {
"description": "name for add-on's initial attachment",
"example": {
"name": "DATABASE_FOLLOWER"
},
"name": {
"description": "unique name for this add-on attachment to this app",
"example": "DATABASE",
"readOnly": true,
"type": [
"string"
]
},
"type": [
"object"
]
},
"config": {
"additionalProperties": false,
"description": "custom add-on provisioning options",
"example": {
"db-version": "1.2.3"
},
"patternProperties": {
"^\\w+$": {
"type": [
"string"
]
}
},
"properties": {},
"type": [
"object"
]
},
"plan": {
"anyOf": [
{
"description": "unique identifier of this plan",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"format": "uuid",
"readOnly": true,
"type": [
"string"
]
},
{
"description": "unique name of this plan",
"example": "heroku-postgresql:dev",
"readOnly": true,
"type": [
"string"
]
}
]
}
},
"required": [
"plan"
],
"type": [
"object"
]
}
Calls PATCH /apps/#{app_identity}/addons/#{addon_identity}
params
is JSON encoded and passed as the request body.
params Schema
{
"properties": {
"plan": {
"anyOf": [
{
"description": "unique identifier of this plan",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"format": "uuid",
"readOnly": true,
"type": [
"string"
]
},
{
"description": "unique name of this plan",
"example": "heroku-postgresql:dev",
"readOnly": true,
"type": [
"string"
]
}
]
}
},
"required": [
"plan"
],
"type": [
"object"
]
}