System Status Tools


Introduction
Endpoints

Introduction

REST API End Points for managing and checking GD System Status Tools.

EndPoints

/wp-json/geodir/v2/system_status/tools

Output

[
    {
        "id": "clear_version_numbers",
        "name": "Clear version numbers",
        "action": "Run",
        "description": "This will force install/upgrade functions to run.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/clear_version_numbers"
                }
            ]
        }
    },
    {
        "id": "check_reviews",
        "name": "Check reviews",
        "action": "Run",
        "description": "Check reviews for correct location and content settings.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/check_reviews"
                }
            ]
        }
    },
    {
        "id": "install_pages",
        "name": "Create default GeoDirectory pages",
        "action": "Run",
        "description": "Note: This tool will install all the missing GeoDirectory pages. Pages already defined and set up will not be replaced.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/install_pages"
                }
            ]
        }
    },
    {
        "id": "recount_terms",
        "name": "Term counts",
        "action": "Run",
        "description": "This tool will recount the listing terms.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/recount_terms"
                }
            ]
        }
    },
    {
        "id": "export_db_texts",
        "name": "DB text translation",
        "action": "Run",
        "description": "This tool will collect any texts stored in the DB and put them in the file db-language.php so they can then be used to translate them by translations tools.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/export_db_texts"
                }
            ]
        }
    }
]

/wp-json/geodir/v2/system_status/tools/

Example

/wp-json/geodir/v2/system_status/tools/clear_version_numbers

Output

[
    {
        "id": "clear_version_numbers",
        "name": "Clear version numbers",
        "action": "Run",
        "description": "This will force install/upgrade functions to run.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/clear_version_numbers"
                }
            ]
        }
    },
    {
        "id": "check_reviews",
        "name": "Check reviews",
        "action": "Run",
        "description": "Check reviews for correct location and content settings.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/check_reviews"
                }
            ]
        }
    },
    {
        "id": "install_pages",
        "name": "Create default GeoDirectory pages",
        "action": "Run",
        "description": "Note: This tool will install all the missing GeoDirectory pages. Pages already defined and set up will not be replaced.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/install_pages"
                }
            ]
        }
    },
    {
        "id": "recount_terms",
        "name": "Term counts",
        "action": "Run",
        "description": "This tool will recount the listing terms.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/recount_terms"
                }
            ]
        }
    },
    {
        "id": "export_db_texts",
        "name": "DB text translation",
        "action": "Run",
        "description": "This tool will collect any texts stored in the DB and put them in the file db-language.php so they can then be used to translate them by translations tools.",
        "_links": {
            "item": [
                {
                    "embeddable": true,
                    "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/export_db_texts"
                }
            ]
        }
    }
]

/wp-json/geodir/v2/system_status/tools/

Example

/wp-json/geodir/v2/system_status/tools/clear_version_numbers

Output

{
    "id": "clear_version_numbers",
    "name": "Clear version numbers",
    "action": "Run",
    "description": "This will force install/upgrade functions to run.",
    "success": true,
    "message": "Version numbers cleared. Install/upgrade functions will run on next page load.",
    "_links": {
        "item": [
            {
                "embeddable": true,
                "href": "http://local.newwp.test/wp-json/geodir/v2/system_status/tools/clear_version_numbers"
            }
        ]
    }
}
Was this article helpful to you? Yes No