ConfigStoreApi.md

Fastly.ConfigStoreApi

const apiInstance = new Fastly.ConfigStoreApi();

Methods

Note

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

Method	HTTP request	Description
createConfigStore	POST /resources/stores/config	Create a config store
deleteConfigStore	DELETE /resources/stores/config/{config_store_id}	Delete a config store
getConfigStore	GET /resources/stores/config/{config_store_id}	Describe a config store
getConfigStoreInfo	GET /resources/stores/config/{config_store_id}/info	Get config store metadata
listConfigStoreServices	GET /resources/stores/config/{config_store_id}/services	List linked services
listConfigStores	GET /resources/stores/config	List config stores
updateConfigStore	PUT /resources/stores/config/{config_store_id}	Update a config store

createConfigStore

createConfigStore({ , [name] })

Create a config store.

Example

const options = {
  name: "name_example",
};

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

Options

Name	Type	Description	Notes
name	String	The name of the config store.	[optional]

Return type

ConfigStoreResponse

deleteConfigStore

deleteConfigStore({ config_store_id })

Delete a config store.

Example

const options = {
  config_store_id: "config_store_id_example", // required
};

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

Options

Name	Type	Description	Notes
config_store_id	String	An alphanumeric string identifying the config store.

Return type

InlineResponse200

getConfigStore

getConfigStore({ config_store_id })

Describe a config store by its identifier.

Example

const options = {
  config_store_id: "config_store_id_example", // required
};

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

Options

Name	Type	Description	Notes
config_store_id	String	An alphanumeric string identifying the config store.

Return type

ConfigStoreResponse

getConfigStoreInfo

getConfigStoreInfo({ config_store_id })

Retrieve metadata for a single config store.

Example

const options = {
  config_store_id: "config_store_id_example", // required
};

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

Options

Name	Type	Description	Notes
config_store_id	String	An alphanumeric string identifying the config store.

Return type

ConfigStoreInfoResponse

listConfigStoreServices

listConfigStoreServices({ config_store_id })

List services linked to a config store

Example

const options = {
  config_store_id: "config_store_id_example", // required
};

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

Options

Name	Type	Description	Notes
config_store_id	String	An alphanumeric string identifying the config store.

Return type

Object

listConfigStores

listConfigStores({ , [name] })

List config stores.

Example

const options = {
  name: "name_example",
};

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

Options

Name	Type	Description	Notes
name	String	Returns a one-element array containing the details for the named config store.	[optional]

Return type

[ConfigStoreResponse]

updateConfigStore

updateConfigStore({ config_store_id, [name] })

Update a config store.

Example

const options = {
  config_store_id: "config_store_id_example", // required
  name: "name_example",
};

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

Options

Name	Type	Description	Notes
config_store_id	String	An alphanumeric string identifying the config store.
name	String	The name of the config store.	[optional]

Return type

ConfigStoreResponse

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