fimidara — docs

`FimidaraEndpoints.fileBackends.updateConfig`

Parameters

props—Required

{

authToken: string

body: UpdateFileBackendConfigEndpointParams

}

UpdateFileBackendConfigEndpointParams

—Optional

{

workspaceId?: string

configId: string

config: UpdateFileBackendConfigInput

}

UpdateFileBackendConfigInput

—Optional

{

name?: string

description?: string

credentials?: FileBackendConfigCredentials

}

FileBackendConfigCredentials

—Optional

Exact shape depends on backend.

{}

Result

—Optional

{

headers: Headers

body?: UpdateFileBackendConfigEndpointResult

}

UpdateFileBackendConfigEndpointResult

—Optional

{

config: FileBackendConfig

}

FileBackendConfig

—Optional

{

resourceId: string

createdBy: Agent

createdAt: number

lastUpdatedBy: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

workspaceId: string

description?: string

backend: string

}

Agent

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

message: string

field?: string

}

`FimidaraEndpoints.fileBackends.updateConfig`

Parameters

props—Required

{

authToken: string

body: UpdateFileBackendConfigEndpointParams

}

UpdateFileBackendConfigEndpointParams

—Optional

{

workspaceId?: string

configId: string

config: UpdateFileBackendConfigInput

}

UpdateFileBackendConfigInput

—Optional

{

name?: string

description?: string

credentials?: FileBackendConfigCredentials

}

FileBackendConfigCredentials

—Optional

Exact shape depends on backend.

{}

Result

—Optional

{

headers: Headers

body?: UpdateFileBackendConfigEndpointResult

}

UpdateFileBackendConfigEndpointResult

—Optional

{

config: FileBackendConfig

}

FileBackendConfig

—Optional

{

resourceId: string

createdBy: Agent

createdAt: number

lastUpdatedBy: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

workspaceId: string

description?: string

backend: string

}

Agent

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

message: string

field?: string

}

FimidaraEndpoints.fileBackends.updateConfig

Parameters

UpdateFileBackendConfigEndpointParams

UpdateFileBackendConfigInput

FileBackendConfigCredentials

Result

UpdateFileBackendConfigEndpointResult

FileBackendConfig

Agent

Throws

FimidaraEndpointErrorItem

Loading...

FimidaraEndpoints.fileBackends.updateConfig

Parameters

UpdateFileBackendConfigEndpointParams

UpdateFileBackendConfigInput

FileBackendConfigCredentials

Result

UpdateFileBackendConfigEndpointResult

FileBackendConfig

Agent

Throws

FimidaraEndpointErrorItem

`FimidaraEndpoints.fileBackends.updateConfig`

`FimidaraEndpoints.fileBackends.updateConfig`