Jump to

• Request
• Response

Retrieve file in use details for given filename and type

get

https://cloud-native-SBC-IP/config/v1/file-in-use/{Type}/{FileName}

Retrieve file in use details for given filename and type(ca-cert,rbt,lrt). Response with in-use as false indicates that given filename and type is not in use. A HTTP '404' status code indicates that given type does not exist on server

Request

Path Parameters

• FileName: string
  Name of file to be retrieved
• Type:
  Type of file to be retrieved

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return file in use

Body ()

Root Schema : FileInUse

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• details: array details
• in-use: boolean

{
    "properties":{
        "in-use":{
            "type":"boolean"
        },
        "details":{
            "items":{
                "$ref":"#/components/schemas/FileUseDetails"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : details

Type: array

Show Source

• Array of: object FileUseDetails
  details of file in use

{
    "items":{
        "$ref":"#/components/schemas/FileUseDetails"
    },
    "type":"array"
}

Nested Schema : FileUseDetails

Type: object

details of file in use

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• element: string
• store: string
  Allowed Values: [ "active", "staging" ]
• value: string

{
    "properties":{
        "element":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "store":{
            "$ref":"#/components/schemas/StorageType"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"details of file in use",
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top