Skip to content

Latest commit

 

History

History
126 lines (80 loc) · 4.15 KB

DirectorBackendApi.md

File metadata and controls

126 lines (80 loc) · 4.15 KB
Raw

DirectorBackendApi

Note

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

Method HTTP request Description
create_director_backend POST /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} Create a director-backend relationship
delete_director_backend DELETE /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} Delete a director-backend relationship
get_director_backend GET /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} Get a director-backend relationship

create_director_backend

Establishes a relationship between a Backend and a Director. The Backend is then considered a member of the Director and can be used to balance traffic onto.

let cfg = &Configuration::default();
let params = CreateDirectorBackendParams {
    // parameters
};
create_director_backend(cfg, params)

Parameters

Name Type Description Required Notes
director_name String Name for the Director. [required]
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
backend_name String The name of the backend. [required]

Return type

crate::models::DirectorBackend

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

delete_director_backend

Deletes the relationship between a Backend and a Director. The Backend is no longer considered a member of the Director and thus will not have traffic balanced onto it from this Director.

let cfg = &Configuration::default();
let params = DeleteDirectorBackendParams {
    // parameters
};
delete_director_backend(cfg, params)

Parameters

Name Type Description Required Notes
director_name String Name for the Director. [required]
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
backend_name String The name of the backend. [required]

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_director_backend

Returns the relationship between a Backend and a Director. If the Backend has been associated with the Director, it returns a simple record indicating this. Otherwise, returns a 404.

let cfg = &Configuration::default();
let params = GetDirectorBackendParams {
    // parameters
};
get_director_backend(cfg, params)

Parameters

Name Type Description Required Notes
director_name String Name for the Director. [required]
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
backend_name String The name of the backend. [required]

Return type

crate::models::DirectorBackend

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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