ex_heroku_client v0.3.0 Heroku.SslEndpoint

Summary

Functions

Calls POST /apps/#{app_identity}/ssl-endpoints

Calls DELETE /apps/#{app_identity}/ssl-endpoints/#{ssl_endpoint_identity}

Calls GET /apps/#{app_identity}/ssl-endpoints/#{ssl_endpoint_identity}

Calls GET /apps/#{app_identity}/ssl-endpoints

Calls PATCH /apps/#{app_identity}/ssl-endpoints/#{ssl_endpoint_identity}

Functions

create(app_identity, params)

Calls POST /apps/#{app_identity}/ssl-endpoints

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "certificate_chain": {
      "description": "raw contents of the public certificate chain (eg: .crt or .pem file)",
      "example": "-----BEGIN CERTIFICATE----- ...",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "preprocess": {
      "default": true,
      "description": "allow Heroku to modify an uploaded public certificate chain if deemed advantageous by adding missing intermediaries, stripping unnecessary ones, etc.",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "private_key": {
      "description": "contents of the private key (eg .key file)",
      "example": "-----BEGIN RSA PRIVATE KEY----- ...",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "certificate_chain",
    "private_key"
  ],
  "type": [
    "object"
  ]
}
destroy(app_identity, ssl_endpoint_identity)

Calls DELETE /apps/#{app_identity}/ssl-endpoints/#{ssl_endpoint_identity}

get(app_identity, ssl_endpoint_identity)

Calls GET /apps/#{app_identity}/ssl-endpoints/#{ssl_endpoint_identity}

index(app_identity)

Calls GET /apps/#{app_identity}/ssl-endpoints

update(app_identity, ssl_endpoint_identity, params \\ %{})

Calls PATCH /apps/#{app_identity}/ssl-endpoints/#{ssl_endpoint_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "certificate_chain": {
      "description": "raw contents of the public certificate chain (eg: .crt or .pem file)",
      "example": "-----BEGIN CERTIFICATE----- ...",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "preprocess": {
      "default": true,
      "description": "allow Heroku to modify an uploaded public certificate chain if deemed advantageous by adding missing intermediaries, stripping unnecessary ones, etc.",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "private_key": {
      "description": "contents of the private key (eg .key file)",
      "example": "-----BEGIN RSA PRIVATE KEY----- ...",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "rollback": {
      "default": false,
      "description": "indicates that a rollback should be performed",
      "example": false,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    }
  },
  "type": [
    "object"
  ]
}