Skip to content

Latest commit

 

History

History
228 lines (168 loc) · 6.26 KB

DirectorApi.md

File metadata and controls

228 lines (168 loc) · 6.26 KB
Raw

Fastly.DirectorApi

const apiInstance = new Fastly.DirectorApi();

Methods

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
createDirector POST /service/{service_id}/version/{version_id}/director Create a director
deleteDirector DELETE /service/{service_id}/version/{version_id}/director/{director_name} Delete a director
getDirector GET /service/{service_id}/version/{version_id}/director/{director_name} Get a director
listDirectors GET /service/{service_id}/version/{version_id}/director List directors
updateDirector PUT /service/{service_id}/version/{version_id}/director/{director_name} Update a director

createDirector

createDirector({ service_id, version_id, [backends, ][capacity, ][comment, ][name, ][quorum, ][shield, ][type, ][retries] })

Create a director for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  backends: [new Fastly.Backend()],
  capacity: 56,
  comment: "comment_example",
  name: "name_example",
  quorum: 75,
  shield: "'null'",
  type: 1,
  retries: 5,
};

apiInstance.createDirector(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
backends [Backend] List of backends associated to a director. [optional]
capacity Number Unused. [optional]
comment String A freeform descriptive note. [optional]
name String Name for the Director. [optional]
quorum Number The percentage of capacity that needs to be up for a director to be considered up. 0 to 100. [optional] [defaults to 75]
shield String Selected POP to serve as a shield for the backends. Defaults to null meaning no origin shielding if not set. Refer to the POPs API endpoint to get a list of available POPs used for shielding. [optional] [defaults to 'null']
type Number What type of load balance group to use. [optional] [one of: 1, 3, 4]
retries Number How many backends to search if it fails. [optional] [defaults to 5]

Return type

DirectorResponse

deleteDirector

deleteDirector({ service_id, version_id, director_name })

Delete the director for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  director_name: "director_name_example", // required
};

apiInstance.deleteDirector(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
director_name String Name for the Director.

Return type

InlineResponse200

getDirector

getDirector({ service_id, version_id, director_name })

Get the director for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  director_name: "director_name_example", // required
};

apiInstance.getDirector(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
director_name String Name for the Director.

Return type

DirectorResponse

listDirectors

listDirectors({ service_id, version_id })

List the directors for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
};

apiInstance.listDirectors(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.

Return type

[DirectorResponse]

updateDirector

updateDirector({ service_id, version_id, director_name })

Update the director for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  director_name: "director_name_example", // required
};

apiInstance.updateDirector(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
director_name String Name for the Director.

Return type

DirectorResponse

[Back to top] [Back to API list] [Back to README]